feat: restructure docs #551
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
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 |
anxolin
force-pushed
the
restructure-docs
branch
from
25ecc51 to
beafeb3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/