search

duckdb / duckdb-web

DuckDB website and documentation
https://duckdb.org
MIT License
160 stars 297 forks source link

Proposal: Reorder Left Menu for better flow #2853

Open corwinjoy opened 4 months ago

corwinjoy commented 4 months ago

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 commented 3 months ago

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

corwinjoy commented 3 months ago

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

soerenwolfers commented 2 months ago

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.