Skip to content

Conversation

jordanstephens
Copy link
Member

This PR prepares and serves a file at docs/samples.md which is hidden in the navigation sidebar, but which can be used as a reference by the docs chatbot.

There are a few small changes we make to the docs as we concatenate them:

  • link the first top-level header to the samples repo directory for this sample
  • increase the heading level by one step for the new page (## Configuration -> ### Configuration)
  • remove any horizontal rules
  • remove any images

which is the concatenation of all of the sample readmes. it shouldn't be
visible in the sidebar, but it should be accessible with the url so that
the docs chatbot can link to it as a reference
@jordanstephens jordanstephens requested a review from commit111 July 2, 2025 22:04
Copy link
Contributor

@commit111 commit111 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, will have to remember to fetch the latest version of the samples repo when running docs locally.

@jordanstephens jordanstephens merged commit e5c224f into main Jul 2, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants