datahub icon indicating copy to clipboard operation
datahub copied to clipboard

Improve the docs based on the feedback

Open Daniellappv opened this issue 1 year ago • 0 comments

Documentation:

TODO

  • [ ] Breadcrumbs: breadcrumb navigation at the top: so users can easily navigate to the previous page they were on
  • [ ] Reorder it: It's well documented, but it would be better to have it ordered even in the sidebar. eg., frist "docs", followed by "Getting Started" or similar, and then others.
  • [ ] Custom Domain: When I am adding a custom domain, it might be better to have some more info to explain how or some link to an external or an internal doc for explanation.
  • [ ] Examples: More examples of charts and markdown templates for creating good documents
  • [x] Markdown: Adding markdown instructions could be a cool thing. Added https://datahub.io/@olayway/docs/Markdown%20syntax%20support
  • [x] Components: I was kinda lost to what exactly can be rendered or not, in regards to the markdown document and plots with plotly. Added https://datahub.io/@olayway/docs/Add%20visuals%20and%20data-rich%20components#what-features-are-supported

NICE-TO-HAVE

  • Split the documentation: for regular users and developers and use a toggle like this one to switch between these 2 modes Screenshot 2024-07-03 at 12 42 27

  • Next topic/previous topic: links at the bottom of each doc page: this will help the user maintain a sense of journeying through the docs, and they also know what comes next

  • Relative path: add docs for multilevel structures and how to do relative path properly

  • [ ] Notion: There is no info on how to publish a notion doc

Daniellappv avatar Jul 16 '24 12:07 Daniellappv