Skip to content

fix(docs): keep the published docs site buildable - #528

Merged
yordis merged 2 commits into
mainfrom
yordis/saskatoon
Aug 6, 2026
Merged

fix(docs): keep the published docs site buildable#528
yordis merged 2 commits into
mainfrom
yordis/saskatoon

Conversation

@yordis

@yordis yordis commented Aug 5, 2026

Copy link
Copy Markdown
Member
  • The Docs Pages workflow has been failing on main since feat(session): stamp turn identity and record tool call read sets #523, so the docs site has not deployed for the last five pushes.
  • The docs build only ran after merge, so a page that breaks the site could not be caught by review or by any check; this adds the missing pre-merge check so the same class of breakage cannot land again.
  • Research dossiers should not be able to take the whole site down through wrapping choices that are invisible in a plain Markdown preview.
  • Cross-tree references to files that are not part of the docs site need to read as paths, not as links the site is expected to resolve.

The Docs Pages workflow has been failing on main since #523, so no docs deploy has shipped.

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Copilot AI lite review requested due to automatic review settings August 5, 2026 23:45

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@cursor

cursor Bot commented Aug 5, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Changes are limited to CI and documentation markdown; no application or auth logic is affected.

Overview
Restores a reliable docs build after Pages failures on main since #523 by catching breakages before deploy.

A new CI Docs workflow (.github/workflows/ci-docs.yml) runs pnpm docs:build in docs/ on pushes to main and on PRs that touch docs/** or the workflow itself, mirroring the Pages job (Node 26, frozen lockfile, DOCS_BASE).

Research dossier edits fix VitePress-only failures that normal Markdown preview hides: long lines are re-wrapped so inline code and links are not split across lines, and references to repo paths outside the site (e.g. proto/trogonai/...) are shown as `path` text instead of markdown links the site cannot resolve. One glossary link path is corrected (../../../../../../../).

Reviewed by Cursor Bugbot for commit 938b22f. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The changes update session-store research documentation. They clarify Amazon Q resume behavior, correct repository and glossary links, and reformat recovery guidance without changing its meaning.

Changes

Session-store documentation

Layer / File(s) Summary
Resume behavior guidance
docs/research/session-store/products/amazon-q/index.md
Clarifies that ChatArgs has no --session <id> flag or session picker. Resumption remains directory-scoped.
Documentation links and formatting
docs/research/session-store/products/claude-agent-sdk/session-types.md, docs/research/session-store/products/crush/vs-session-events.md, docs/research/session-store/products/fx/index.md
Updates repository and glossary links. Rewraps the FX recovery instruction without changing its wording or meaning.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: copilot

Poem

A rabbit checks each link in line,
And finds the paths now point just fine.
Resume rules sit clear and bright,
While wrapped-up guidance reads just right.
Hop, hop—docs are set tonight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the primary objective: keeping the published documentation site buildable.
Description check ✅ Passed The description directly explains the documentation build failures and the changes that prevent similar failures.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yordis/saskatoon

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The docs build only ran after merge, so a broken page could not be caught by review or by any check.

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
Copilot AI review requested due to automatic review settings August 5, 2026 23:50

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@yordis
yordis merged commit 662864b into main Aug 6, 2026
13 checks passed
@yordis
yordis deleted the yordis/saskatoon branch August 6, 2026 00:17
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.

2 participants