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.

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

Review the documentation and improve the layout #100

Open
bahmanm opened this issue Feb 4, 2024 · 0 comments
Open

Review the documentation and improve the layout #100

bahmanm opened this issue Feb 4, 2024 · 0 comments
Assignees
Labels
📚 documentation Improvements or additions to documentation
Milestone

Comments

@bahmanm
Copy link
Owner

bahmanm commented Feb 4, 2024

Ideally each the doc for each feature, should start w/ a brief intro, at least one example (or synopsis) followed by functionalities/variables/targets.

Additionally, at this stage, the landing page is quite long and confusing. One possible improvement is moving the installation and usage sections to a "getting started" page to keep the landing page as lean as possible.

@bahmanm bahmanm added the 📚 documentation Improvements or additions to documentation label Feb 4, 2024
@bahmanm bahmanm added this to the 0.8.0 milestone Feb 4, 2024
@bahmanm bahmanm self-assigned this Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant