Skip to content

fix: docs polish — external link check, OpenAPI card, navbar#3

Merged
indykish merged 4 commits into
mainfrom
fix/docs-polish
Apr 4, 2026
Merged

fix: docs polish — external link check, OpenAPI card, navbar#3
indykish merged 4 commits into
mainfrom
fix/docs-polish

Conversation

@indykish
Copy link
Copy Markdown
Contributor

@indykish indykish commented Apr 4, 2026

Summary

  • Fix OpenAPI spec card link to point to raw GitHub URL (was api.usezombie.com/openapi.json, not deployed)
  • Add markdown-link-check to make lint for external URL validation in CI
  • Rename navbar "Support" → "Talk to us", pointing to usezombie.com/contact/sales

Test plan

  • make lint passes locally (mintlify validate + broken-links + markdown-link-check)

🤖 Generated with Claude Code

indykish and others added 3 commits April 4, 2026 12:16
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 4, 2026

Greptile Summary

This PR makes three documentation polish fixes: (1) corrects the OpenAPI spec card link in api-reference/introduction.mdx from the undeployed api.usezombie.com/openapi.json to the correct raw GitHub URL (consistent with the docs.json openapi field), (2) adds markdown-link-check to make lint for external URL validation with a .mlc-config.json config, and (3) renames the navbar "Support" link to "Talk to us" pointing to usezombie.com/contact/sales.

  • OpenAPI card href now matches the raw GitHub URL already used in docs.json for the API reference tab
  • markdown-link-check integrates with existing mintlify validate and mintlify broken-links steps
  • Navbar rename aligns the CTA label with the destination page intent
  • The two key concerns (POSIX ** glob expansion in the Makefile and the usezombie.com exclusion from link checking) were raised and acknowledged in previous review threads; the exclusion is intentional pending domain availability in CI

Confidence Score: 5/5

Safe to merge — all three fixes are correct and previously flagged concerns have been acknowledged by the developer.

All changes are straightforward and correctly implemented. The OpenAPI URL is now consistent between the card and docs.json. The link-checker config and Makefile addition are functional. The two concerns raised in previous review threads were addressed as intentional. No new blocking issues were found.

No files require special attention.

Important Files Changed

Filename Overview
.mlc-config.json New link-check config with intentional ignore patterns for usezombie.com domains (unreachable in CI) and standard exclusions for relative paths and mailto links
Makefile Adds markdown-link-check step to lint target using **/*.mdx glob; glob expansion limitation in POSIX sh was flagged and acknowledged in a prior review thread
api-reference/introduction.mdx OpenAPI spec card href corrected from undeployed api.usezombie.com URL to the raw GitHub URL, now consistent with docs.json
docs.json Navbar 'Support' renamed to 'Talk to us' pointing to usezombie.com/contact/sales

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Make as make lint
    participant MV as mintlify validate
    participant MB as mintlify broken-links
    participant MLC as markdown-link-check

    Dev->>Make: make lint
    Make->>MV: npx mintlify validate
    MV-->>Make: pass / fail
    Make->>MB: npx mintlify broken-links
    MB-->>Make: pass / fail
    Make->>MLC: npx markdown-link-check --config .mlc-config.json **/*.mdx
    Note over MLC: Ignores usezombie.com,<br/>app.usezombie.com,<br/>discord.gg, mailto:, relative paths
    MLC-->>Make: pass / fail
    Make-->>Dev: lint result
Loading

Reviews (2): Last reviewed commit: "fix: use find instead of glob for recurs..." | Re-trigger Greptile

Comment thread Makefile Outdated
Comment thread .mlc-config.json
**/*.mdx silently skips nested files in POSIX sh. Use find to ensure
all subdirectories are checked.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@indykish indykish merged commit e8095e6 into main Apr 4, 2026
3 checks passed
@indykish indykish deleted the fix/docs-polish branch April 4, 2026 08:27
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.

1 participant