feat: restructure docs - #551
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
25ecc51 to
beafeb3
Compare
|
Will be closed. Context here: https://nomevlabs.slack.com/archives/C035N0YEB6J/p1761829543409939 DEMO: https://docs-git-restructure-docs-cowswap.vercel.app Pawel plans to enhance the docs, might take also some ideas from thie PoC |
Description
This PR restructure the documentation to be simpler to navigate and understand.
Disclaimer
This change has been vibe code using Claude. We can review it and accept it or use it as a prototype to experiment with this idea of simplifying the docs.
Context
It is a bit hard to find anything in https://docs.cow.fi anymore.
The main reason is that it tries to document all products in the same place. Normally, readers only learn about one product at a time.
Trying to have all the produc pages under the same menu increases the number of levels in the menu. There's some pages that are hidden in level 5!!! (see how ideally 2 levels is best https://ux.stackexchange.com/questions/38948/two-level-menus-why-and-when?utm_source=chatgpt.com)
Breaking in apps removes all the cluter and allow us to have a better search, only local to the product.
Also, I took this chance to highlight more products like the widget, and make the SDK and API more accesible.
Changes
Test
https://docs-git-restructure-docs-cowswap.vercel.app/