Add CI for documentation. Minor improvement and organisation of website#350
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a dedicated GitHub Actions workflow to build the Docusaurus website (catching broken links via Docusaurus settings) and adjusts the main CI trigger to skip runs for website/markdown-only changes, alongside small documentation/website organization updates.
Changes:
- Add a new
docs-checkworkflow to build the website onwebsite/**changes. - Update main CI triggers to ignore
website/**and**/*.md-only changes. - Reorganize website navigation and fix/adjust documentation links and labels.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
website/sidebars.ts |
Renames “User Guide” category to “Clients”, adds external Java link, and surfaces Contributing directly. |
website/docs/user-guide/*/example/_category_.json |
Renames “Example” to “Examples” in multiple language sections. |
website/docs/release/verifying-a-release-candidate.md |
Fixes/updates internal docs links to match current website structure. |
website/docs/release/generate-release-note.md |
Updates links, but introduces an instruction/link mismatch for release-note generation flow. |
website/docs/index.md |
Updates intro text and section naming to match the new sidebar organization and Java link. |
website/docs/developer-guide/_category_.json |
Removes the Developer Guide category metadata (sidebar now links directly to Contributing). |
.github/workflows/docs-check.yml |
Adds website build workflow, but uses likely-invalid action major versions. |
.github/workflows/ci.yml |
Adds paths-ignore to avoid running main CI for website/markdown-only changes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
luoyuxia
reviewed
Feb 18, 2026
Contributor
There was a problem hiding this comment.
@leekeiabstraction Thanks for the pr. LGTM. Merging...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Linked issue: close #347
Brief change log
Tests