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 a readme to the examples and list them on the website #42

Open
zhouzi opened this issue Apr 28, 2022 · 0 comments
Open

Add a readme to the examples and list them on the website #42

zhouzi opened this issue Apr 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@zhouzi
Copy link
Owner

zhouzi commented Apr 28, 2022

It would be great to add a readme to the examples to explain how they work. These readmes could then be automatically copied to a docs/docs/examples/ folder when building the website. They could serve as a guide for advanced features such as #41
@zhouzi zhouzi added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 28, 2022
@zhouzi zhouzi changed the title Add a readme to the example and list them on the website Add a readme to the examples and list them on the website May 3, 2022
@zhouzi zhouzi removed the help wanted Extra attention is needed label Dec 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zhouzi