Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Describing actions, observations and safety checks & integrate examples #177

Merged
merged 3 commits into from
Sep 18, 2024

Conversation

luator
Copy link
Member

@luator luator commented Sep 18, 2024

Description

  • Add a page describing general structure of actions and observations.
  • Also describe the safety checks there.
  • Integrate some basic examples into the docs, so it's easier to reference them.

How I Tested

Built locally.

Integrate some of the basic examples into the docs by adding pages with
`literalinclude`.  This makes it nicer to read and easier to reference
specific examples within the documentation.
Add links to the safety check section to related configuration values.
@luator luator added the documentation Improvements or additions to documentation label Sep 18, 2024
@luator luator self-assigned this Sep 18, 2024
@luator luator merged commit 74dcfd4 into master Sep 18, 2024
7 checks passed
@luator luator deleted the fkloss/doc_action_obs branch September 18, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant