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

Re-organize the documentation #231

Open

3 tasks

alexgarel opened this issue Aug 20, 2024 · 0 comments

Labels

📚 Documentation

Member

alexgarel commented Aug 20, 2024

Reorganize documentation

Beta Give feedback

Create dev documentation by taking scattered documentation in a more organized way (intro / how-to / etc) and replace by link to relevant parts
Rethink README to link to documentation and only provide a short introduction
Add more links on documentation introduction to relevant sub-parts
Options

github-project-automation bot added this to 🔎 Search-a-licious

github-project-automation bot moved this to Backlog (ready for dev) in 🔎 Search-a-licious

alexgarel added the 📚 Documentation label

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