-
Notifications
You must be signed in to change notification settings - Fork 198
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
Add links to examples folder #132
Comments
This would be beneficial, as new users might not know that examples are located under the This should be relatively easy. Just detect if there is |
Triage: This can be part of #740 as we pass the |
Could also be related to #238, in that if we start generating documentation for examples then they'll have |
This should be quite doable already. docs.rs includes the examples in the source tab, for example https://docs.rs/crate/chumsky/latest/source/examples/brainfuck.rs And docs.rs is aware of how to get to the source tab. So now it should just be a matter of putting the right link in the side-bar, I suppose? |
Everything except the topbar of the documentation pages is generated by rustdoc, we don't really want to be trying to inject extra stuff into the side-bar after the page was generated. |
Not sure if it is possible, but as examples are complimentary to documentation, it would be nice if docs.rs could provide links to examples in the repo examples directory (even perhaps render them?).
The text was updated successfully, but these errors were encountered: