Skip to content
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

Merged
merged 9 commits into from
Aug 21, 2023
Merged

Big Docs Revisit! #551

merged 9 commits into from
Aug 21, 2023

Conversation

simonswiss
Copy link
Collaborator

@simonswiss simonswiss commented Aug 18, 2023

Putting this in Draft because I ran out of time and kids are calling. Will pick up on Monday. Needs review, but I 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 into Local mode and GitHub mode pages. The GitHub mode page is the former Connect to GitHub guide which wasn't placed ideally in the flow of the docs.

  • Organised the Organised content and path mess into two pages: Organised content and Path 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

@changeset-bot
Copy link

changeset-bot bot commented Aug 18, 2023

⚠️ No Changeset found

Latest commit: c58e16b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Aug 18, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
keystar-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2023 2:40am
keystatic ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2023 2:40am
keystatic-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2023 2:40am

@simonswiss simonswiss marked this pull request as ready for review August 21, 2023 01:55
@simonswiss
Copy link
Collaborator Author

Reviewed internal links for all pages to make sure they are updated to the new pages — all is well!

@simonswiss
Copy link
Collaborator Author

simonswiss commented Aug 21, 2023

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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant