Feature: added docs.jso validator + bug fix at docs.json

[SantiagoDePolonia]

Summary by CodeRabbit

• Chores

  • Added automated documentation validation to the CI pipeline to improve quality assurance.

• Documentation

  • Initialized documentation navigation configuration (placeholder pages) for future organization.

• Style

  • Updated documentation theme color for improved visual appearance.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new CI job "Docs Validation" to run documentation checks and updates docs theme color from rgb(51,52,54) to #755c3d; also adds a navigation object with an empty pages array in docs.json.

Changes

Cohort / File(s)	Summary
CI Workflow ​.github/workflows/test.yml	Adds a new "Docs Validation" job that checks out the repo, installs Node.js 22, and runs npx mint validate in the docs directory.
Docs configuration docs/docs.json	Changes primary color from rgb(51,52,54) to #755c3d and replaces an empty object with a navigation object containing an empty pages array.

Sequence Diagram(s)

sequenceDiagram
  participant Runner as GitHub Actions Runner
  participant Repo as Repository (checkout)
  participant Node as setup-node (Node.js 22)
  participant Mint as npx mint (docs validator)

  Runner->>Repo: actions/checkout (clone code)
  Runner->>Node: actions/setup-node@v3 (install Node 22)
  Runner->>Repo: cd docs
  Runner->>Mint: npx mint validate (run docs validation)
  Mint-->>Runner: exit status (pass/fail)

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• feat: added a basic docs.json #58 — Previously added or modified docs/docs.json; this PR further adjusts the primary color and navigation structure.

Poem

🐰 I hopped through YAML, line by line,
I nudged a color, made docs align.
I told the CI to check with care,
Now russet pages glow and share. 🥜

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title contains a typo ('docs.jso' instead of 'docs.json') and is partially accurate—it mentions both the validator addition and docs.json changes, but the typo creates confusion about what was actually modified.	Correct the typo to 'docs.json' and consider clarifying whether the changes to docs.json represent a bug fix or configuration updates for the validator feature.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/mintlify2

---

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

🤖 Fix all issues with AI agents

In @.github/workflows/test.yml:
- Around line 99-101: The CI step named "Validate docs.json" currently runs "npx
mint validate" which fetches the latest Mintlify CLI; change this to pin the CLI
to a specific, secure version (at least v4.2.210) to ensure reproducible builds.
Update the step's run command (the one containing "npx mint validate") to use a
pinned version such as "npx mint@4.2.210 validate" (keeping the
working-directory: docs), or another exact version >= 4.2.210 if you prefer.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/docs.json`:
- Around line 8-10: Populate the navigation.pages array in docs.json so existing
docs appear in the site; add entries for each file (FUTURE_ARCHITECTURE.md,
TESTING_STRATEGY.md, adr/0001-explicit-provider-registration.md,
plans/token-usage-tracking.md) under the "navigation" -> "pages" key, using
readable titles and their relative paths (ensure the key is named "pages" and
the JSON remains valid), e.g., create objects with title and path for each
document so navigation.pages references each document file.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, check the full docs.json file to understand the context
cat -n docs/docs.json

Repository: ENTERPILOT/GOModel

Length of output: 348

---

🏁 Script executed:

# Search for markdown/mdx files in the docs directory
fd -e mdx -e md . docs/

Repository: ENTERPILOT/GOModel

Length of output: 197

---

🏁 Script executed:

# Also check the overall structure of the docs directory
tree -L 3 docs/ 2>/dev/null || find docs -type f | head -20

Repository: ENTERPILOT/GOModel

Length of output: 253

---

Populate pages array — existing documentation files won't be discoverable.

The navigation.pages array is empty, so the Mintlify documentation site won't display the existing documentation files (FUTURE_ARCHITECTURE.md, TESTING_STRATEGY.md, adr/0001-explicit-provider-registration.md, plans/token-usage-tracking.md). Add entries to the pages array for each documentation file so they appear in the navigation.

🤖 Prompt for AI Agents

In `@docs/docs.json` around lines 8 - 10, Populate the navigation.pages array in
docs.json so existing docs appear in the site; add entries for each file
(FUTURE_ARCHITECTURE.md, TESTING_STRATEGY.md,
adr/0001-explicit-provider-registration.md, plans/token-usage-tracking.md) under
the "navigation" -> "pages" key, using readable titles and their relative paths
(ensure the key is named "pages" and the JSON remains valid), e.g., create
objects with title and path for each document so navigation.pages references
each document file.