Skip to content

Fix dead VitePress link to resourceWrite command#165

Merged
connor4312 merged 1 commit into
mainfrom
colbylwilliams/fix-ci-on-main
May 28, 2026
Merged

Fix dead VitePress link to resourceWrite command#165
connor4312 merged 1 commit into
mainfrom
colbylwilliams/fix-ci-on-main

Conversation

@colbylwilliams

Copy link
Copy Markdown
Member

Why

The Deploy Documentation workflow has been failing on every merge into main since #152. The build fails with:

[vitepress] 2 dead link(s) found.

Both links point to /reference/commands#resourcewrite, but there is no commands page in the generated reference. The pages are per-channel (common, root, session, terminal, changeset, otlp) plus messages and error-codes. The resourceWrite command is defined on the common channel (docs/reference/common.md#resourcewrite), which is what docs/reference/messages.md already links to.

What

  • Updated the JSDoc on DirectoryCustomization in types/channels-session/state.ts to use /reference/common#resourcewrite. This is the source of truth for the link that ends up in the generated docs/reference/session.md.
  • Updated the same link in the hand-written docs/guide/customizations.md.
  • Ran npm run generate to refresh the derived schema and Rust outputs that embed the JSDoc as descriptions.

Verification

npm run docs:build now completes successfully:

✓ building client + server bundles...
✓ rendering pages...
build complete in 6.61s.

npm run typecheck passes.

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>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 DirectoryCustomization JSDoc 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 connor4312 enabled auto-merge May 28, 2026 15:04
@connor4312 connor4312 merged commit a47c2d7 into main May 28, 2026
8 checks passed
@connor4312 connor4312 deleted the colbylwilliams/fix-ci-on-main branch May 28, 2026 15:04
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.

3 participants