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

Proposal: Reorder Left Menu for better flow #2853

Open
corwinjoy opened this issue May 10, 2024 · 3 comments
Open

Proposal: Reorder Left Menu for better flow #2853

corwinjoy opened this issue May 10, 2024 · 3 comments
Assignees
Labels
enhancement Small improvement in the documentation, e.g., documenting some slighly unexpected behavior

Comments

@corwinjoy
Copy link
Contributor

As a new user, when I came to the website to read the documentation I found the left menu order to be somewhat disorienting. Reading top to bottom, after Installation it goes right into detailed documentation which was confusing. I propose that a more natural flow would be to have an overview and/or example before plunging in to the details. Something like:

  1. Installation
  2. Why DuckDB
  3. Maybe a brief example here?
  4. Documentation
    ...
  5. Sitemap (I think it would make sense to have this at the end as it is essentially an index like what books have).

Thoughts?

@szarnyasg
Copy link
Collaborator

Hi @corwinjoy, I fully agree – I will work on streamlining the documentation in the coming weeks.

@szarnyasg szarnyasg self-assigned this Jun 1, 2024
@szarnyasg szarnyasg added the enhancement Small improvement in the documentation, e.g., documenting some slighly unexpected behavior label Jun 1, 2024
@corwinjoy
Copy link
Contributor Author

Awesome @szarnyasg! Please let me know if there is anything I can do to help or collaborate.

@soerenwolfers
Copy link
Contributor

Not sure how this should be done, but I also sometimes wish data types weren't described so separately from the corresonding methods. Maybe that can just be fixed by making sure they link both ways.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Small improvement in the documentation, e.g., documenting some slighly unexpected behavior
Projects
None yet
Development

No branches or pull requests

3 participants