Add a docs site for changesets - #1512
Conversation
Sorry, something went wrong.
⚠️ No Changeset foundLatest commit: 6e708bd 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 changesetsWhen 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 |
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## next-docs #1512 +/- ##
=============================================
- Coverage 81.93% 81.92% -0.01%
=============================================
Files 54 54
Lines 2458 2457 -1
Branches 723 720 -3
=============================================
- Hits 2014 2013 -1
Misses 401 401
Partials 43 43 ☔ View full report in Codecov by Sentry.
|
Sorry, something went wrong.
|
Looks great to me as an initial setup. There's some plans before to have a proper site for changesets's next major so this pairs quite well with it. I don't know if @Andarist has plans to re-shuffle the docs a bit, e.g. maybe some page links will change. And if so, we could treat the site as "internal" to not commit to a permanent link before we're happy with it, but still merge it to keep the ball rolling. Maybe this could be part of the next branch too. For the existing /docs/ folder in the repo, I guess we have to keep it awhile to not break existing links. |
Sorry, something went wrong.
Yes, I'm not quite sure about your next steps, so this PR does not delete the docs folder but leaves the decision up to you. |
Sorry, something went wrong.
|
I'm going to start working on this by merging into the next-docs branch, which is based on the next branch |
Sorry, something went wrong.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Sorry, something went wrong.
* Add a docs site for `changesets` (changesets#1512) Co-authored-by: bluwy <bjornlu.dev@gmail.com> * Update docs * Remove docsearch dependencies * Adjust colors * Move pages * Improve code blocks * Add group icons * Add head tags * Fix lint error * Apply suggestions from code review Co-authored-by: Adam Haglund <adam@haglund.dev> * Simplify main readme * Add Netlify stuff * Update picomatch links * packageManager with h4sh * update local node version * Fix lint * Rewrite intro pages - rewrite getting-started - rewrite concepts -> origins - rewrite common-questions -> faq - delete what-are-changesets (covered in getting-started) - delete dictionary (explain everything inline where possible) * Fix site build * Tweak styles * Improve faq * Update automating-changesets * Update acknowledgements * Update config page * Improve getting-started * Sync code groups * Update cli * Update CLI page * Automate CLI page * Rename origins to why * Rename technical decisions * Move experimental options to config page * Add changeset file icon * Update fixed and linked packages docs * Flatten guide folder * Re-order sections * Update why * Update changelog format * Add customize commit page * Rewrite prereleases * Use generator for changelog and commit * Separate versioning and publishing guide * Publish first time * Update snapshot releases * Fix git tag * Remove versioning-apps because it's clunky * Add backport guide * Fix netlify build * Update og description * Update readme * Update `snapshot.useCalculatedVersion` docs * Fix install * clarify and explain publishing new packages and their dist-tags * reorder package managers * add note regarding pnpm * try to clarify separate-branch prerelease flow make seperate-branch flow easier to distinguish re-order parts for clarity * clarify that `exit` should be run on the separate branch * Fix lint * Add pm info and commit-short docs * Update CLI page * Document `publishConfig.directory` fix changesets#733 * Add simple section for deleting package fix changesets#1416 * Document nightly usecase and pkg.pr.new fix changesets#1091 * Document accidental new package publish fix changesets#756 Co-authored-by: Melanie Seltzer <melanieseltzer1@gmail.com> * Update git-tag docs * docs: make init command interactive (changesets#2088) * Add packages pages * docs: create page for GitHub generator package (changesets#2127) * Add warnings for old docs pages * Update changelog github docs * Add more popular-ish packages docs * Tweak wording * Add basic migration page * docs: update and enhance comparison to other tools (changesets#2126) * update pnpm * update vitepress * add changes from changesets#2150 Co-Authored-By: Emmet Moore <130148281+emmet-opinionx@users.noreply.github.com> * Add blog pages and og images (changesets#2154) * remove unnecessary property * Add private packages docs Co-authored-by: Emelia Smith <ThisIsMissEm@users.noreply.github.com> * Update as beyond npm --------- Co-authored-by: Akino <akinochen@foxmail.com> Co-authored-by: Adam Haglund <adam@haglund.dev> Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> Co-authored-by: Melanie Seltzer <melanieseltzer1@gmail.com> Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com> Co-authored-by: Emmet Moore <130148281+emmet-opinionx@users.noreply.github.com> Co-authored-by: Emelia Smith <ThisIsMissEm@users.noreply.github.com>
Close #1134
This PR introduces the following changes:
Here is the demo site: https://akinoccc.github.io/changesets/
Here are the snapshots from the site:
