-
Notifications
You must be signed in to change notification settings - Fork 75
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
Big Docs Revisit! #551
Big Docs Revisit! #551
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Reviewed internal links for all pages to make sure they are updated to the new pages — all is well! |
I am confident this radically improves the flow of the documentation, but since there are some "sweeping" changes, I'd like to at least bring some attention to it before merging. That said — it would also be good to merge soon before this becomes a "monster PR" — and the other work I want to do (use Cloud images, work on copy on particular pages, etc) would all benefit from this being merged first. So @JedWatson I'll leave this open for a bit so you can have a look and pull the handbrake if you feel there's a need to, otherwise I am going to make a judgment call and merge it :) |
Putting this in Draft because I ran out of time and kids are calling. Will pick up on Monday. Needs review, butI think it definitely improves a lot of things.The navigation on the left flows much more naturally, there are less confused and slightly overlapping, double-up pages.
A bit in WIP mode as I pushed when I ran out of time.A pretty good Friday afternoon session, I gotta say!
Rough list of what this PR does:
Removed the
Local vs GitHub
page, broken down intoLocal mode
andGitHub mode
pages. TheGitHub mode
page is the formerConnect to GitHub
guide which wasn't placed ideally in the flow of the docs.Organised the
Organised content
andpath
mess into two pages:Organised content
andPath Wildcard
.Rewrote a ton of copy trying to make it simpler, less story-telly, more like a set of instructions.
Created permanent redirects in the next config file for the old pages.
Preview URL
https://keystatic-site-git-docs-iteration-thinkmill-labs.vercel.app/docs/introduction