feat(docs): link the OpenAPI reference from the docs nav

[PierreBrisorgueil]

The docs module's own nav + home linked only the home + guides, never /docs/api (the in-theme OpenAPI reference, hidden from the main sidenav). Now the reference is reachable from WITHIN /docs: a persistent 'API reference' nav entry (→ /docs/api, config-driven title/icon) + a quiet home CTA next to the quickstart. Internal router-links, generic. 128 docs tests + 2376 full + build green.

Summary by CodeRabbit

• New Features
  • Added a persistent "API reference" link in the documentation sidebar, always available for quick access.
  • Added an "API reference" call-to-action button to the documentation home quickstart section.
  • Reference link title and icon are customizable through configuration with sensible defaults.

[Copilot]

Pull request overview

Updates the docs module navigation so the in-theme OpenAPI reference at /docs/api is discoverable from within the /docs surface (nav + home), aligning the docs UX with the existing reference route.

Changes:

• Add a persistent “API reference” entry to the docs module sidebar nav (title/icon driven by config.docs.reference).
• Add a secondary CTA on the docs home quickstart hero linking to /docs/api.
• Extend docs unit tests to cover the new reference link behavior in both nav and home.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
src/modules/docs/views/docs.home.view.vue	Adds an “API reference” CTA next to the quickstart primary CTA; reads title/icon from config with defaults.
src/modules/docs/components/docs.nav.component.vue	Adds a persistent sidebar nav item linking to /docs/api with config-driven title/icon.
src/modules/docs/tests/docs.nav.component.unit.tests.js	Updates config mock + router and adds assertions for the new reference nav link (including empty-category case).
src/modules/docs/tests/docs.home.view.unit.tests.js	Updates router and adds assertions for the new reference CTA in the quickstart hero.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.56%. Comparing base (ef79603) to head (41e9e0c).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4330   +/-   ##
=======================================
  Coverage   99.56%   99.56%           
=======================================
  Files          34       34           
  Lines        1388     1388           
  Branches      433      433           
=======================================
  Hits         1382     1382           
  Misses          6        6           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5985ddd2-127a-40ed-9633-9cb25f6f72a2

📥 Commits

Reviewing files that changed from the base of the PR and between ef79603 and 41e9e0c.

📒 Files selected for processing (4)

• src/modules/docs/components/docs.nav.component.vue
• src/modules/docs/tests/docs.home.view.unit.tests.js
• src/modules/docs/tests/docs.nav.component.unit.tests.js
• src/modules/docs/views/docs.home.view.vue

---

Walkthrough

Adds a persistent "API reference" link to the docs sidebar nav and the docs home quickstart hero, both routing to /docs/api. The link title and icon are sourced from config.docs.reference with hardcoded fallbacks. Unit tests for both surfaces are updated accordingly.

Changes

API Reference Link in Docs Nav and Home

Layer / File(s)	Summary
Docs home reference CTA — template and script setup src/modules/docs/views/docs.home.view.vue	Adds a reference constant from config.docs.reference with icon/title fallbacks, and renders a new always-visible API reference button in the quickstart hero alongside the existing conditional quickstart button.
Docs nav sidebar persistent reference link src/modules/docs/components/docs.nav.component.vue	Inserts a persistent v-list-item linking to /docs/api before the dynamic guide categories, wired to new referenceTitle and referenceIcon computed properties with fallback defaults from config.docs.reference.
Unit tests for nav and home reference link src/modules/docs/tests/docs.nav.component.unit.tests.js, src/modules/docs/tests/docs.home.view.unit.tests.js	Updates config mocks and router fixtures to include the /docs/api route, then asserts the nav renders the reference link with config-driven title and href, and the home quickstart hero renders the API reference CTA with correct text and link target.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• pierreb-devkit/Vue#3943: Removes the entire docs module and its /docs routes, directly conflicting with this PR's addition of the /docs/api route and docs nav/home changes.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/docs-nav-api-reference-link

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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