Skip to content

[failproofai-562] docs: link the docs logo to befailproof.ai#563

Merged
hermes-exosphere merged 2 commits into
mainfrom
luv-562
Jul 17, 2026
Merged

[failproofai-562] docs: link the docs logo to befailproof.ai#563
hermes-exosphere merged 2 commits into
mainfrom
luv-562

Conversation

@NiveditJain

Copy link
Copy Markdown
Member

What

The Failproof AI logo in the docs navbar now links to https://befailproof.ai.

The logo was already clickable — Mintlify's default sends it to the docs homepage. This sets logo.href to retarget it at the landing page, so readers have a way back to the product from every docs page.

   "logo": {
     "light": "/logo/Failproof_AI_logo_light.png",
-    "dark": "/logo/Failproof_AI_logo.png"
+    "dark": "/logo/Failproof_AI_logo.png",
+    "href": "https://befailproof.ai"
   },

Checks

  • logo.href is the documented Mintlify field for this ("URL to redirect to when clicking the logo"); verified against the settings schema reference.
  • docs.json still parses.
  • scripts/translate-docs/mintlify-nav.ts does a full parse → mutate → stringify and only touches navigation, so the daily translation pass preserves the new key.
  • CHANGELOG.md entry added under the current 0.0.14-beta.1 — 2026-07-17 section.

Not verified locally

The rendered page was not confirmed by clicking it. Local Mintlify wouldn't run: Docker Desktop's WSL integration is off (so Dockerfile.docs can't run), and mintlify dev refuses Node 26 — Dockerfile.docs pins Node 22 for exactly that reason. Worth a click on the preview deploy before merge.

Tradeoff

The logo no longer returns readers to the docs homepage — the conventional affordance. Accepted deliberately; an explicit navbar link was the considered alternative. The footer already links to befailproof.ai (#556).

🤖 Generated with Claude Code

The navbar logo used Mintlify's default target, the docs homepage. Set
logo.href so it points at the landing page instead, giving readers a way
back to the product from every docs page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@NiveditJain, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 9 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

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

How do review limits work?

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

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, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8fc91647-92ea-4aa8-973d-678d4f91c02e

📥 Commits

Reviewing files that changed from the base of the PR and between 36b3c0a and 0700e2e.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • docs/docs.json

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

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

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@hermes-exosphere
hermes-exosphere merged commit 6dfc781 into main Jul 17, 2026
11 checks passed
@hermes-exosphere

Copy link
Copy Markdown
Contributor

Automated code review started - full review. Results will be posted here.

@hermes-exosphere

Copy link
Copy Markdown
Contributor

Analysis complete. 2 files changed (+3/-1): docs/docs.json and CHANGELOG.md. No build needed — pure config + docs change. Validated: JSON syntax, Mintlify schema conformance, translate-pipeline preservation. Posting detailed review next.

@hermes-exosphere

Copy link
Copy Markdown
Contributor

Automated Code Review

Executive Summary

This PR sets the docs logo link to https://befailproof.ai via Mintlify's logo.href config. A minimal, well-scoped change: 3 lines added across 2 files (docs.json + CHANGELOG). JSON parses correctly, the field is Mintlify-documented, and the translation pipeline preserves it through round-trips. No breaking changes, no logic issues, no bugs. Ready to merge.


Change Architecture

graph TD
    A["docs/docs.json<br/>logo config"] -->|"+ href: befailproof.ai"| B["Mintlify Renderer<br/>navbar logo"]
    C["scripts/translate-docs/mintlify-nav.ts"] -->|"parses docs.json<br/>mutates only navigation"| D["docs.json (rewritten)"]
    A -->|"logo preserved<br/>by stringify round-trip"| D
    E["CHANGELOG.md"] -->|"+ entry under 0.0.14-beta.1"| F["Docs section updated"]
    style A fill:#87CEEB
    style C fill:#87CEEB
    style B fill:#90EE90
    style E fill:#87CEEB
Loading

Legend: Green = New | Blue = Modified | Yellow = Breaking Change Risk


Breaking Changes

No breaking changes detected.


Issues Found

No issues found. The change is structurally sound.


Logical / Bug Analysis

1. JSON validity: VERIFIED. Loaded the actual file from the PR head commit (0700e2e) via browser -- JSON.parse() succeeds with no errors. The logo object now has light, dark, and href keys, all properly typed.

2. Mintlify schema conformance: VERIFIED. The Mintlify docs show: "logo": { "light": "/logo.png", "dark": "/logo-dark.png", "href": "https://mintlify.com" } -- exact same shape. logo.href is described as "URL to redirect to when clicking the logo."

3. Translation pipeline preservation: VERIFIED. mintlify-nav.ts -> updateDocsJson() reads the FULL docs.json (including logo, navbar, footer), mutates ONLY config.navigation, then writes the ENTIRE config back via JSON.stringify(config) -- preserving all top-level keys including logo.href.

4. No trailing comma: VERIFIED. The diff adds "href": "https://befailproof.ai" as the last key in the logo object, with NO trailing comma, matching existing style.

5. CHANGELOG format: VERIFIED. Entry follows the ### Docs section pattern: - sentence. (#563).


Issue Linkage

NOTE: This PR is titled "[failproofai-562]" and branched from luv-562, but issue #562 is about PostHog telemetry -- unrelated to docs logo. The branch name appears to be a leftover from a prior task. The PR body correctly references #556 (footer changes) as related.


Human Review Feedback

No human review comments exist on this PR.


Suggestions

  1. PR title mismatch: Title "[failproofai-562]" doesn't match content. Consider renaming to "docs: link the docs logo to befailproof.ai" (which is also the commit message).

  2. Consider a navbar link alternative: The logo no longer returns to the docs homepage. An explicit "Docs Home" link in the navbar would preserve the conventional affordance. This is a UX preference, not a code issue.

  3. Preview deploy check: Verify on the Vercel/Mintlify preview deploy that clicking the logo navigates to befailproof.ai before merging.


Verdict

VERDICT: APPROVED


Automated code review -- 2026-07-17 11:11 UTC

@hermes-exosphere hermes-exosphere left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review: Approved. No issues found. 2 files (+3/-1): docs/docs.json adds logo.href, CHANGELOG updated. JSON valid, Mintlify schema verified, translation pipeline preservation confirmed. See review summary comment for full analysis.

Comment thread docs/docs.json
"logo": {
"light": "/logo/Failproof_AI_logo_light.png",
"dark": "/logo/Failproof_AI_logo.png"
"dark": "/logo/Failproof_AI_logo.png",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VERIFIED: logo.href is the correct Mintlify field. The Mintlify docs show the exact same shape: \logo: { \light: ..., \dark: ..., \href: ...\ }. This is the documented way to redirect the logo click.

@hermes-exosphere hermes-exosphere left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated review: Approved. ✅

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.

2 participants