Skip to content

fix: replace Mintlify branding and add real API reference#2

Open
indykish wants to merge 2 commits intomainfrom
fix/readme-cleanup
Open

fix: replace Mintlify branding and add real API reference#2
indykish wants to merge 2 commits intomainfrom
fix/readme-cleanup

Conversation

@indykish
Copy link
Copy Markdown
Contributor

@indykish indykish commented Apr 3, 2026

Summary

  • Rewrite README.md to match usezombie repo standard (badges, concise dev section, license)
  • Update docs.json: name, anchors, navbar, footer socials to UseZombie
  • API reference tab now auto-generates 43 endpoint pages from remote OpenAPI spec (raw.githubusercontent.com/usezombie/usezombie/main/public/openapi.json)
  • Rewrite api-reference/introduction.mdx with real auth flow, error format, and conventions
  • Remove Mintlify sample endpoint pages and local openapi.json copy

Test plan

  • Verify Mintlify build succeeds with remote OpenAPI URL
  • Verify API reference pages render with correct grouping (12 groups, 43 endpoints)
  • Confirm README badges and links point to usezombie.com

🤖 Generated with Claude Code

@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Apr 3, 2026

Greptile Summary

This PR completes the migration from Mintlify starter-kit branding to UseZombie branding across all three surface areas: README.md, api-reference/introduction.mdx, and docs.json. It also replaces the handful of hand-written sample endpoint pages with a fully auto-generated API reference (43 endpoints across 12 groups) driven by the remote OpenAPI spec at raw.githubusercontent.com/usezombie/usezombie/main/public/openapi.json.

Key changes:

  • README.md — replaced Mintlify boilerplate with badges, concise dev workflow, and MIT license notice
  • api-reference/introduction.mdx — rewritten with real auth flow (OAuth polling pattern), structured error envelope with request_id, and API conventions (UUIDs, Unix ms timestamps, :action suffix, SSE streaming)
  • docs.json — added openapi source URL on the API reference tab, expanded navigation to all 12 endpoint groups, updated footer Discord URL, added Website anchor, removed Blog anchor

Confidence Score: 5/5

Safe to merge — only one minor style nit remains, no functional or logic issues.

All changes are documentation and configuration updates. The single remaining finding is a P2 sentence-case style violation in the frontmatter title, which does not affect build correctness or user-facing functionality. Prior concerns about the OpenAPI URL and OpenAPI card href were intentionally accepted as wontfix by the team.

No files require special attention.

Important Files Changed

Filename Overview
README.md Replaces Mintlify starter boilerplate with UseZombie-specific branding, badges, and concise dev/publishing sections. No issues found.
api-reference/introduction.mdx Rewrites API intro with auth flow, error format, and conventions. Title uses title case ("API Reference") instead of the required sentence case ("API reference").
docs.json Adds remote OpenAPI spec URL and expands navigation to 12 endpoint groups matching the spec. Branding, footer, and anchor updates all look correct.

Sequence Diagram

sequenceDiagram
    participant GH as GitHub (usezombie/usezombie)
    participant Mintlify as Mintlify Build
    participant Docs as docs.usezombie.com

    GH->>Mintlify: Fetch openapi.json from main branch
    Mintlify->>Mintlify: Auto-generate 43 endpoint pages (12 groups)
    Mintlify->>Docs: Deploy static API reference site

    Note over Mintlify,Docs: Triggered on push to default branch

    actor User
    User->>Docs: Browse API reference
    Docs-->>User: Rendered endpoint pages

    User->>Docs: Click "OpenAPI Spec" card
    Docs-->>User: Redirect to api.usezombie.com/openapi.json
Loading
Prompt To Fix All With AI
This is a comment left during a code review.
Path: api-reference/introduction.mdx
Line: 2

Comment:
**Title should use sentence case**

Per the project style guide, all headings should use sentence case. `'API Reference'` capitalizes "Reference", which is title case. It should be `'API reference'` (with "API" kept uppercase as an acronym).

```suggestion
title: 'API reference'
```

**Context Used:** AGENTS.md ([source](https://app.greptile.com/review/custom-context?memory=e994989b-b25e-4468-be5d-6bde3ddb0ce6))

How can I resolve this? If you propose a fix, please make it concise.

Reviews (2): Last reviewed commit: "feat: auto-generate API reference from r..." | Re-trigger Greptile

indykish and others added 2 commits April 4, 2026 00:59
- Rewrite README.md to match usezombie repo standard (badges, concise sections)
- Update docs.json: name, anchors, navbar, footer socials to UseZombie

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Point docs.json openapi to raw GitHub URL for usezombie/public/openapi.json
- Rewrite api-reference/introduction.mdx with real auth flow, errors, conventions
- Remove Mintlify sample endpoint pages (get, create, delete, webhook)
- Remove local openapi.json copy (single source of truth in usezombie repo)
- Add 12 API groups with 43 endpoints in chronological agent-followable order

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@indykish indykish force-pushed the fix/readme-cleanup branch from 21a0bb5 to 7c07826 Compare April 3, 2026 19:31
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