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

docs: Move user guide to index page #38

Open
jpsamaroo opened this issue Aug 8, 2023 · 0 comments
Open

docs: Move user guide to index page #38

jpsamaroo opened this issue Aug 8, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jpsamaroo
Copy link
Member

The index page (docs/src/index.md) is too basic and focused on users who care more about the DTable internals, rather than how to use it. I propose moving either the User Guide or the quickstart examples (proposed in #37) to this index page, and moving the content that's currently in the index page to a "Background" or "Technical Details" page or something like that.

@jpsamaroo jpsamaroo added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 8, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant