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

use code blocks for making the doc chapter more self contained #122

Closed
SaranjeetKaur opened this issue Nov 29, 2022 · 1 comment
Closed

use code blocks for making the doc chapter more self contained #122

SaranjeetKaur opened this issue Nov 29, 2022 · 1 comment
Assignees
@SaranjeetKaur
Labels
documentation Improvements or additions to documentation

Comments

@SaranjeetKaur
Copy link
Collaborator

Just a suggestion: Instead of referring to an external resource, you could also copy a significant portion (or all) of that as a code block and then when explaining the components later on in a bit more detail, point to the sections in the example. This would make for a bit more self-contained reading.

Originally posted by @nbenn in #66 (comment)
@SaranjeetKaur SaranjeetKaur self-assigned this Apr 4, 2023
@SaranjeetKaur SaranjeetKaur added the documentation Improvements or additions to documentation label May 9, 2023
@SaranjeetKaur
Copy link
Collaborator Author

@nbenn - I made the suggested changes and by mistake merged the commit into the main branch!

Please review the commit and let me know your feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SaranjeetKaur SaranjeetKaur

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SaranjeetKaur