Readme

[jonathanpopham]

Summary by CodeRabbit

• New Features

  • Comprehensive dark-mode styling applied across the site.

• Documentation

  • Rebranded and reorganized docs toward Supermodel API.
  • Updated guides, examples and API endpoints to production URLs.
  • Added sections: API key, Quickstart, Updating docs/API reference, Accuracy policy, Support, Local development.
  • Nav/footer links updated and some schema references removed.

• Chores

  • Added CI workflow to validate docs and check links.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This PR rebrands docs to Supermodel, replaces staging URLs with production endpoints across MDX files, adds a GitHub Actions CI workflow for JSON validation and link-checking, updates docs.json config, and introduces extensive dark-mode CSS overrides.

Changes

Cohort / File(s)	Summary
CI workflow .github/workflows/ci.yml	Adds GitHub Actions "CI" job on push/PR that checks out code, validates docs.json with jq, rejects staging URLs via rg, and runs link checks with lycheeverse/lychee-action against README.md and all .mdx files.
Top-level docs & branding README.md, docs.json	Rebrands README to "Supermodel API Documentation"; updates docs.json (removes $schema, points OpenAPI to raw GitHub URL, updates navbar and social links).
Docs: auth & examples authentication.mdx, index.mdx, quickstart.mdx	Switches staging dashboard and API hosts to production (dashboard.supermodeltools.com, api.supermodeltools.com) in explanatory text and curl/examples.
Styling / dark mode overrides.css	Introduces extensive .dark mode overrides forcing black backgrounds, sets root CSS variables to black, disables translucency/blur, and restores visibility of formerly hidden docs/blog anchors.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Developer
  participant GitHub as "GitHub Actions"
  participant Repo as "Repository"
  participant jq as "jq (JSON validator)"
  participant rg as "rg (regex check)"
  participant Lychee as "lychee-action (link checker)"

  Developer->>GitHub: push / open PR
  GitHub->>Repo: checkout code
  GitHub->>jq: validate docs.json
  jq-->>GitHub: pass/fail
  GitHub->>rg: scan for staging URLs
  rg-->>GitHub: pass/fail
  GitHub->>Lychee: run link checks on README.md + **/*.mdx
  Lychee-->>GitHub: report results
  GitHub-->>Developer: CI pass/fail status
  rect rgba(0,128,0,0.06)
    note right of GitHub: Success path
  end
  rect rgba(255,0,0,0.06)
    note right of GitHub: Failure path (fails CI)
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

✨ Staging doors closed, production takes flight,
Dark mode turned on, the docs glow at night.
CI hums a tune — jq, rg, lychee in sync,
Supermodel docs ship; push, check, and blink.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Readme' is too vague and generic—it doesn't convey what actually changed in the PR.	Use a more descriptive title that captures the main change, like 'Update documentation for production API and styling' or 'Migrate from staging to production endpoints'.

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

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84917a6 and 2d6f095.

📒 Files selected for processing (1)

• .github/workflows/ci.yml

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/workflows/ci.yml

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

overrides.css (1)

1-37: Consider removing duplicate CSS rules.

There's some duplication in the dark mode overrides that could be cleaned up:

• Lines 1-5 are duplicated at lines 28-32 (:root variables)
• Lines 7-10 are duplicated at lines 34-37 (html.dark, body.dark, .dark rules)
• Lines 12-18 overlap with lines 40-45 (.dark .bg-background-* rules)

This doesn't break anything since CSS just uses the last declaration, but removing the duplicates would make the file easier to maintain.

🔎 Suggested cleanup

You can remove lines 1-37 entirely since lines 39-135 already cover all the same rules plus additional ones. The duplicate declarations at the top appear to be leftover from development.

-:root {
-  --bg-dark: #000000 !important;
-  --bg-default: #000000 !important;
-  --bg-background-dark: #000000 !important;
-}
-
-html.dark, body.dark, .dark {
-  background-color: #000000 !important;
-  --tw-ring-offset-color: #000000 !important;
-}
-
-.dark .bg-background-dark {
-  background-color: #000000 !important;
-}
-
-.dark .bg-background-light {
-  background-color: #000000 !important;
-}
-
-.dark main {
-  background-color: #000000 !important;
-}
-
-.dark nav, .dark aside {
-  background-color: #000000 !important;
-  border-right-color: #1F1F1F !important;
-}
-:root {
-  --bg-dark: #000000 !important;
-  --bg-default: #000000 !important;
-  --bg-background-dark: #000000 !important;
-}
-
-html.dark, body.dark, .dark {
-  background-color: #000000 !important;
-  --tw-ring-offset-color: #000000 !important;
-}
-
 /* Force black on all major layout containers */
 .dark .bg-background-dark {
   background-color: #000000 !important;

Then add the :root declaration once at the top if it's not already there below line 37.

.github/workflows/ci.yml (2)

19-24: Consider edge cases for the staging URL guard.

The regex pattern staging\\. will catch obvious staging URLs like staging.supermodeltools.com, which is great. However, just a heads up on potential edge cases:

• It won't catch staging URLs without a subdomain (like supermodelstaging.com or paths like example.com/staging/api)
• It might flag legitimate uses of the word "staging" in documentation text

If you have specific staging URL patterns to guard against, you could make the pattern more precise. For example, if all your staging URLs follow the pattern staging.supermodeltools.com, you could use:

if rg -n "staging\\.supermodeltools\\.com" .; then

This reduces false positives while still catching the URLs you care about.

---

26-36: HTTP 429 acceptance could hide broken links.

The link checker accepts 429 (Too Many Requests) as a valid response. While this prevents CI from breaking when external servers rate-limit you, it creates a blind spot: if you accidentally typo a URL (like api.example.com/v1/usres instead of /users), and the server rate-limits before returning a 404, the check will pass even though the link is actually broken.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6482aed and 84917a6.

📒 Files selected for processing (7)

• .github/workflows/ci.yml
• README.md
• authentication.mdx
• docs.json
• index.mdx
• overrides.css
• quickstart.mdx

🔇 Additional comments (8)

docs.json (3)

58-58: Dashboard URL update is consistent.

This matches the production URL migration pattern across all documentation files.

---

63-64: Social media links check out. Both the X and GitHub profiles are live and accessible (HTTP 200). No action needed.

---

40-40: No action needed—OpenAPI spec URL is accessible and valid.

The URL at line 40 is publicly accessible and returns valid OpenAPI 3.0.0 YAML content.

authentication.mdx (1)

7-7: Authentication docs updated consistently.

All three URL updates follow the same production migration pattern seen throughout the PR. The authentication flow documentation now correctly points users to the production dashboard and API endpoints.

Also applies to: 10-10, 40-40

quickstart.mdx (1)

11-11: Good to go on the production URLs.

The dashboard link and API endpoint are both using the right production domains (dashboard.supermodeltools.com and api.supermodeltools.com). Users following this quickstart will hit the real services, not any staging or test endpoints. Clean and ready.

index.mdx (1)

11-11: Dashboard URL is correct and consistent with the codebase.

The link to https://dashboard.supermodeltools.com/ matches the official production dashboard URL used throughout the documentation (authentication.mdx, quickstart.mdx, README.md, and docs.json). This is the right reference for users to get their API key.

.github/workflows/ci.yml (1)

1-17: Nice workflow structure!

The CI setup is clean and well-organized. The three validation steps (JSON validation, staging URL guard, link checking) are logically separated and easy to understand. The JSON validation using jq is a simple and effective way to catch malformed config files early.

README.md (1)

35-39: No changes needed—mint is the official Mintlify CLI package.

The package name is actually correct. Mintlify's CLI is published to npm as simply mint (not a scoped package like @mintlify/cli). This is the official package, so npm i -g mint is the right command.