docs(docs): add a module README

[PierreBrisorgueil]

What

The docs module shipped without a README.md; its consumed backend contract, surfaces, rendering pipeline, and config knobs lived only in scattered code comments. Adds src/modules/docs/README.md documenting:

• the consumed contract (GET /api/public/docs wire shape incl. the optional per-guide anchor, GET /api/spec.json),
• the routes/surfaces (/docs, /docs/api, /docs/:category/:slug),
• the useDocsPage rendering pipeline (heading anchors · runnable examples · cross-link rewrite),
• the config knobs (personas, quickstart, reference.tagGuides, fuzzy search).

Points at code rather than restating it. Verified accurate against the current module (search is fuzzy-only post-#4332; no Algolia).

Closes #4339

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for the Docs module covering client surface, backend integration, frontend routing, rendering pipeline, and configurable overrides.

[coderabbitai]

Warning

Review limit reached

@PierreBrisorgueil, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 55 minutes and 3 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6fccfe89-c2cf-4522-a98f-a036c944a141

📥 Commits

Reviewing files that changed from the base of the PR and between c487add and 2b976ad.

📒 Files selected for processing (1)

• src/modules/docs/README.md

Walkthrough

Adds src/modules/docs/README.md (69 lines) documenting the Docs module's /docs client routes, unauthenticated backend API contract, wire shape for category/guide data, useDocsPage rendering pipeline, config/docs.config.js override points, and search/nav sidebar behavior.

Changes

Docs Module README

Layer / File(s)

Summary

Docs module README content src/modules/docs/README.md

Populates the previously empty README with the module's client routes, backend API contract (GET /api/public/docs, article, and OpenAPI spec endpoints), category/guide wire shape including the optional anchor field, useDocsPage rendering pipeline (heading anchors, example extraction/hydration markers, cross-link rewriting), config/docs.config.js override points (home/personas/quickstart, OpenAPI tag mapping, fuzzy search), and sidebar tree/search nav behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• pierreb-devkit/Vue#4330: Introduces the persistent /docs/api OpenAPI reference route and related config that this README now documents under the frontend routing and configuration sections.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs(docs): add a module README' is concise and directly describes the main change—adding documentation for the docs module.
Description check	✅ Passed	The PR description covers the Summary, what changed, why, and linked issues; however, the Scope and Validation sections from the template are missing.
Linked Issues check	✅ Passed	The PR directly addresses issue #4339 by adding the requested README.md documenting the consumed contract, routes, rendering pipeline, and config knobs as specified.
Out of Scope Changes check	✅ Passed	All changes are scoped to adding documentation for the docs module; no unrelated code modifications or out-of-scope alterations are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/docs-module-readme

---

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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/modules/docs/README.md`:
- Around line 12-16: Add the `text` language identifier to two unlabeled code
fence blocks in the README.md file. The first code block contains the API
endpoint examples starting with GET /api/public/docs, and the second code block
contains the URL path examples starting with /docs. For each code block, change
the opening fence from triple backticks to triple backticks followed by the word
`text` on the same line.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: b6b66bbf-ca7b-4ecd-b706-e7472c92ae74

📥 Commits

Reviewing files that changed from the base of the PR and between a89331c and c487add.

📒 Files selected for processing (1)

• src/modules/docs/README.md

[Copilot]

Pull request overview

Adds a module-level README for the docs module to centralize the consumed backend contract, routes, rendering pipeline, and config knobs so downstream consumers can integrate/override it correctly.

Changes:

• Add src/modules/docs/README.md documenting the public docs API contract and wire shape.
• Document the module’s routes (/docs, /docs/api, /docs/:category/:slug) and the useDocsPage rendering pipeline (ToC, runnable examples, cross-link rewrites).
• Summarize downstream config surface (config.docs.*) including personas/quickstart/reference/search.