Skip to content

docs: point remaining "Quickstart with Hermes" links at the Hermes quickstart#5394

Closed
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:docs/fix-hermes-quickstart-links
Closed

docs: point remaining "Quickstart with Hermes" links at the Hermes quickstart#5394
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:docs/fix-hermes-quickstart-links

Conversation

@harjothkhara

@harjothkhara harjothkhara commented Jun 13, 2026

Copy link
Copy Markdown

Summary

Three more documentation pages had a "Quickstart with Hermes" link pointing at the OpenClaw quickstart source file (../get-started/quickstart) instead of the Hermes quickstart (../get-started/quickstart-hermes). Fern resolves relative [](…) links by source-file path, so these resolved to the wrong page. Each occurrence is in a Hermes-only context; the sibling OpenClaw links are correct and left untouched.

This completes the broken-internal-link cleanup also addressed in #5392 (#5076) and #5393 (#5079, #5089), and follows the same approach as the earlier link sweep in #4665.

Changes

  • docs/about/ecosystem-hermes.mdx — Hermes ecosystem page.
  • docs/manage-sandboxes/lifecycle.mdxvariant="hermes" block (the variant="openclaw" block keeps ../get-started/quickstart).
  • docs/inference/use-local-inference.mdx — two variant="hermes" blocks (OpenClaw blocks unchanged).
  • Added test/repro-hermes-quickstart-links.test.ts asserting the corrected targets and that the OpenClaw links are preserved.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications) — plus a regression test under test/
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Verified locally: the Hermes quickstart target source file exists; scripts/docs-to-skills.py … --dry-run succeeds; the new regression test's assertions pass. The full prek / npm test / npm run docs suite was not run locally; leaving those for CI.


Signed-off-by: harjoth harjoth.khara@gmail.com

Summary by CodeRabbit

  • Documentation

    • Updated documentation links to ensure Hermes-related guides correctly reference the Hermes-specific quickstart page.
  • Tests

    • Added regression test to validate Hermes quickstart links are properly configured in documentation.

…ickstart

Three more pages had a "Quickstart with Hermes" link pointing at the OpenClaw
quickstart source file (../get-started/quickstart) instead of the Hermes
quickstart (../get-started/quickstart-hermes). Fern resolves relative links by
source-file path, so these resolved to the wrong page. Each sits in a
Hermes-only context (a variant="hermes" block or the Hermes ecosystem page);
the sibling OpenClaw links are correct and left untouched.

- docs/about/ecosystem-hermes.mdx
- docs/manage-sandboxes/lifecycle.mdx
- docs/inference/use-local-inference.mdx (two occurrences)

Add a regression test. Completes the broken-link class also addressed in

Signed-off-by: harjoth <harjoth.khara@gmail.com>
NVIDIA#5392 (NVIDIA#5076) and NVIDIA#5393 (NVIDIA#5079, NVIDIA#5089).
@copy-pr-bot

copy-pr-bot Bot commented Jun 13, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 07b628b3-6bcf-4d49-a854-525556b1d80c

📥 Commits

Reviewing files that changed from the base of the PR and between 720bee9 and 1ef4d43.

📒 Files selected for processing (4)
  • docs/about/ecosystem-hermes.mdx
  • docs/inference/use-local-inference.mdx
  • docs/manage-sandboxes/lifecycle.mdx
  • test/repro-hermes-quickstart-links.test.ts

📝 Walkthrough

Walkthrough

This PR corrects documentation links across four pages to ensure "Quickstart with Hermes" references point to the Hermes-specific quickstart page (quickstart-hermes). A regression test is added to validate these links remain correct.

Changes

Hermes Quickstart Documentation Links

Layer / File(s) Summary
Hermes quickstart link corrections across documentation
docs/about/ecosystem-hermes.mdx, docs/inference/use-local-inference.mdx, docs/manage-sandboxes/lifecycle.mdx
Four documentation files update "Quickstart with Hermes" links to point to ../get-started/quickstart-hermes instead of the generic quickstart page: the ecosystem overview related topics, local inference prerequisites and next steps sections, and sandbox lifecycle introduction.
Regression test for Hermes quickstart link consistency
test/repro-hermes-quickstart-links.test.ts
A new Vitest test reads documentation content and validates that "Quickstart with Hermes" links resolve to the Hermes-specific quickstart page while preserving expected OpenClaw quickstart links in shared contexts.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

area: docs

Suggested reviewers

  • prekshivyas
  • cv

Poem

🐰 Links now hop the right way,
Hermes quickstart guides the day,
Tests keep them true and bright,
Documentation set just right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing 'Quickstart with Hermes' documentation links to point to the correct Hermes-specific quickstart page instead of the generic one.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@harjothkhara

Copy link
Copy Markdown
Author

Closing this. It built on the same premise as #5392/#5393, and the underlying issues (#5076/#5079/#5089) were all closed as not-planned (docs-link validation false positives). Inside the hermes variant block, ../get-started/quickstart already routes to the Hermes quickstart via the nav slug in docs/index.yml, so these links resolve correctly and rewriting them to quickstart-hermes is the change docs/CONTRIBUTING.md advises against. The maintainer-side link-fix PR (#5460) was also closed unmerged. Closing rather than leaving this open.

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.

1 participant