feat(docs): add docs module with embedded Scalar API reference

[PierreBrisorgueil]

Summary

• Add new docs module at /docs route embedding the @scalar/api-reference Vue component
• Scalar points at the Node API spec endpoint ({api}/spec.json) built from config
• Module is optional, gated by config.modules.docs.activated
• Includes unit tests for view rendering and configuration passing

Closes #3867

Test plan

• npm run lint passes
• npm run test passes (880 tests, 65 files)
• Manual: navigate to /docs with Node API running, verify Scalar renders spec

[coderabbitai]

Warning

Rate limit exceeded

@PierreBrisorgueil has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 21 minutes and 8 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 21 minutes and 8 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c32eb1fd-4682-4cbe-8523-ca62c7783e82

📥 Commits

Reviewing files that changed from the base of the PR and between 5756f9c and eb8a8a2.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (6)

• package.json
• src/config/defaults/development.config.js
• src/modules/app/app.router.js
• src/modules/docs/router/docs.router.js
• src/modules/docs/tests/docs.view.unit.tests.js
• src/modules/docs/views/docs.view.vue

✨ Finishing Touches

🧪 Generate unit tests (beta)

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

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.32%. Comparing base (d49dae0) to head (eb8a8a2).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3873   +/-   ##
=======================================
  Coverage   99.32%   99.32%           
=======================================
  Files          30       30           
  Lines        1030     1030           
  Branches      257      257           
=======================================
  Hits         1023     1023           
  Misses          7        7           

☔ View full report in Codecov by Sentry.
📢 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.

[Copilot]

Pull request overview

Adds a new optional docs module that mounts a /docs route and renders an embedded Scalar API reference pointing at the configured Node API OpenAPI spec endpoint.

Changes:

• Add DocsView that embeds @scalar/api-reference and builds the spec URL from config.api.*.
• Register /docs as an optional module route in the app router.
• Add unit tests verifying the Scalar component renders and receives the expected configuration.

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/modules/docs/views/docs.view.vue	New view embedding Scalar and deriving spec URL from config.
src/modules/docs/tests/docs.view.unit.tests.js	Unit tests for rendering + configuration passing to Scalar.
src/modules/docs/router/docs.router.js	Defines the /docs route and meta.
src/modules/app/app.router.js	Adds docs to the optional modules route list.
src/config/defaults/development.config.js	Enables modules.docs by default in the base config layer.
package.json	Adds @scalar/api-reference dependency.