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.

Sign up for GitHub

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

Jump to bottom

Add README to example directory #57

Open
joshuadavidthomas opened this issue Feb 26, 2024 · 1 comment
Open

Add README to example directory #57

joshuadavidthomas opened this issue Feb 26, 2024 · 1 comment
Labels
📝 needs docs Feature or change that requires documentation

Comments

@joshuadavidthomas
Copy link
Member

For someone clicking around the GitHub UI trying to get a sense of the library, may be useful to have a README within the example directory that copies the installation instructions from the base README, along with some more details regarding what all features the examples are showing off.

We could then just reference the README within the documentation, and have it also be there as well.
@jefftriplett
Copy link
Contributor

It might be worth adding a note about examples/navigation.py in the "Open your browser to http://localhost:8000 to see the examples in action." section of the examples README.

@joshuadavidthomas joshuadavidthomas added the 📝 needs docs Feature or change that requires documentation label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 needs docs Feature or change that requires documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jefftriplett @joshuadavidthomas