Improving documentation to publicize and share the project and codes #580
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Adding examples folder to store all of the examples and applications - Adding some examples from readthedocs ready to run
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi everyone,
I've been thinking about contributing a little to the project's documentation, mainly based on what I saw in the discussion in #371. Based on what I think of the project, there are still many ways to make it more widely used and useful for people, especially those who are just starting out in programming or doing small personal projects.
That said, my suggestion is to add How-To and Tutorials sections so that people can more easily visualize some basic applications and get inspired. I'm leaving the necessary structure for this, and then I can add at least one example of each on the page.
In addition, I also created the examples folder to make it easier to access the code and run it without any major problems, so it's also easier to share and send to other people to test it more directly.