docs: update and enhance comparison to other tools - #2126
Conversation
✅ Deploy Preview for changesets ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next-docs #2126 +/- ##
=============================================
+ Coverage 85.11% 87.28% +2.16%
=============================================
Files 66 71 +5
Lines 2526 2548 +22
Branches 696 681 -15
=============================================
+ Hits 2150 2224 +74
+ Misses 346 300 -46
+ Partials 30 24 -6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…entional commit-based tools
bluwy
left a comment
There was a problem hiding this comment.
Left a small comment but I like the new changes!
Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com>
* 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>
Description
This PR updates the "What distinguishes this from…" section on the "Technical Decisions" page.
One reason I wanted to update it is that it doesn't mention "Release Please", which is also a popular versioning automation tool. I think it fits very well to this section. I created two new subheadings to specifically compare Semantic Release and Release Please individually.
There are also some other reasons to enhance the section - many small details that I wanted to improve. It's probably best to review it by looking at the diff, but to give some overview:
lerna semantic release, which is unmaintained since 2019.I'm open for suggestions, this is a draft of my vision of enhancement for this section. Feel free to suggest feedback 🫶