Skip to content

Add a docs site for changesets#1512

Merged
bluwy merged 4 commits intochangesets:next-docsfrom
akinoccc:main
May 5, 2026
Merged

Add a docs site for changesets#1512
bluwy merged 4 commits intochangesets:next-docsfrom
akinoccc:main

Conversation

@akinoccc
Copy link
Copy Markdown

@akinoccc akinoccc commented Nov 13, 2024

Close #1134

This PR introduces the following changes:

  • Workflow for deploying the documentation site: Adds a CI/CD pipeline to automatically deploy the documentation website.
  • Documentation site content: The site is populated with all documentation files from the docs folder and packages' README.

NOTES: If the PR accessed, I think the folder of docs should be removed.

Here is the demo site: https://akinoccc.github.io/changesets/

Here are the snapshots from the site:
image
image
image

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Nov 13, 2024

⚠️ No Changeset found

Latest 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 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

@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 13, 2024

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.92%. Comparing base (feaa0b6) to head (6e708bd).

Additional details and impacted files
@@              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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bluwy
Copy link
Copy Markdown
Member

bluwy commented Dec 4, 2024

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.

@akinoccc
Copy link
Copy Markdown
Author

akinoccc commented Dec 4, 2024

For the existing /docs/ folder in the repo, I guess we have to keep it awhile to not break existing links.

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.

@bluwy
Copy link
Copy Markdown
Member

bluwy commented May 5, 2026

I'm going to start working on this by merging into the next-docs branch, which is based on the next branch

@bluwy bluwy changed the base branch from main to next-docs May 5, 2026 02:25
@socket-security
Copy link
Copy Markdown

socket-security Bot commented May 5, 2026

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addedvitepress@​2.0.0-alpha.17981008691100

View full report

@bluwy bluwy merged commit 5bdd59d into changesets:next-docs May 5, 2026
9 of 10 checks passed
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.

Website with docs

2 participants