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

[docs] Make index page into "getting started" group #30

Open
sneakers-the-rat opened this issue Oct 2, 2024 · 0 comments
Open

[docs] Make index page into "getting started" group #30

sneakers-the-rat opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sneakers-the-rat
Copy link
Collaborator

The index page has the contents of a quickstart page, but because it's not in a ToC it's easy to skip it and go directly to the inner package contents.

Index page should be split up into

  • installation
  • quickstart (using with models)
  • defining a custom interface?
@sneakers-the-rat sneakers-the-rat added the documentation Improvements or additions to documentation label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sneakers-the-rat