Fix dead VitePress link to resourceWrite command#165
Merged
Conversation
The Deploy Documentation workflow has been failing since PR #152 because two markdown files reference `/reference/commands#resourcewrite`, which is not a real page in the generated reference. The `resourceWrite` command is defined on the `common` channel (`docs/reference/common.md`), so the correct link is `/reference/common#resourcewrite`. Updated the JSDoc on `DirectoryCustomization` in `types/channels-session/state.ts` (which propagates to the generated schema and Rust outputs) and the guide page `docs/guide/customizations.md`, then re-ran `npm run generate` to refresh derived artifacts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Fixes a dead VitePress link that caused the Deploy Documentation workflow to fail. The resourceWrite command lives on the common channel reference page, not a (non-existent) /reference/commands page, so the link is updated in the TypeScript JSDoc source of truth and the hand-written guide, with derived schema and Rust outputs regenerated.
Changes:
- Update
DirectoryCustomizationJSDoc link to/reference/common#resourcewrite. - Update the same link in
docs/guide/customizations.md. - Regenerate JSON schemas and Rust doc comments to match.
Show a summary per file
| File | Description |
|---|---|
| types/channels-session/state.ts | Source-of-truth JSDoc link fix on DirectoryCustomization. |
| docs/guide/customizations.md | Hand-written guide link fix. |
| schema/state.schema.json | Regenerated description with corrected link. |
| schema/notifications.schema.json | Regenerated description with corrected link. |
| schema/errors.schema.json | Regenerated description with corrected link. |
| schema/commands.schema.json | Regenerated description with corrected link. |
| schema/actions.schema.json | Regenerated description with corrected link. |
| clients/rust/crates/ahp-types/src/state.rs | Regenerated Rust doc comment with corrected link. |
Copilot's findings
- Files reviewed: 8/8 changed files
- Comments generated: 0
connor4312
approved these changes
May 28, 2026
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.
Why
The Deploy Documentation workflow has been failing on every merge into
mainsince #152. The build fails with:Both links point to
/reference/commands#resourcewrite, but there is nocommandspage in the generated reference. The pages are per-channel (common,root,session,terminal,changeset,otlp) plusmessagesanderror-codes. TheresourceWritecommand is defined on thecommonchannel (docs/reference/common.md#resourcewrite), which is whatdocs/reference/messages.mdalready links to.What
DirectoryCustomizationintypes/channels-session/state.tsto use/reference/common#resourcewrite. This is the source of truth for the link that ends up in the generateddocs/reference/session.md.docs/guide/customizations.md.npm run generateto refresh the derived schema and Rust outputs that embed the JSDoc as descriptions.Verification
npm run docs:buildnow completes successfully:npm run typecheckpasses.