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

Consider splitting README into multiple docs #411

Open
NyakudyaA opened this issue Jan 29, 2023 · 2 comments
Open

Consider splitting README into multiple docs #411

NyakudyaA opened this issue Jan 29, 2023 · 2 comments

Comments

@NyakudyaA
Copy link
Collaborator

Feature description

The readme has become quite long and will continue to grow, let's consider splitting it and keep the main features here and flesh out most of the doc using either

  • GitHub wiki,
  • Github pages
  • Mkdocs.

We could have the following structure

  • README.md
  • docs/guide.md (Basics & Advanced Features)
  • docs/best-practices.md

Additional context

No response
@NyakudyaA
Copy link
Collaborator Author

This should fix #381

@lewismc
Copy link

lewismc commented Feb 23, 2023

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lewismc @NyakudyaA