Skip to content

Update CLAUDE.md & WORKFLOW.md for current repo state#116

Open
lindy-png wants to merge 1 commit into
mainfrom
docs-update-claude-guidance
Open

Update CLAUDE.md & WORKFLOW.md for current repo state#116
lindy-png wants to merge 1 commit into
mainfrom
docs-update-claude-guidance

Conversation

@lindy-png
Copy link
Copy Markdown
Collaborator

Summary

CLAUDE.md and WORKFLOW.md were stale and would mislead anyone (or their Claude Code) cloning the repo. This brings them in line with reality.

  • mint.jsondocs.json throughout — the repo migrated to Mintlify's docs.json schema on 2026-05-16
  • Documents the current two-tab nav (Documentation / Workflows, maple theme)
  • Fixes the deploy process: main is GitHub branch-protected (no direct pushes; approved PR required; no self-approval), and Mintlify's merge-to-main auto-deploy is unreliable so a manual dashboard trigger is often needed
  • Adds an explicit GitHub branch-protection section

Test plan

  • Docs-only change; no site content affected

- mint.json -> docs.json throughout (repo migrated 2026-05-16)
- Document the two-tab docs.json nav (Documentation / Workflows)
- Correct the deploy process: main is GitHub branch-protected,
  deploys via approved PR, and Mintlify auto-deploy is unreliable
  so a manual dashboard trigger is often needed
- Add a GitHub branch-protection section (PR approval required,
  no self-approval)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 19, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lindyai 🟢 Ready View Preview May 19, 2026, 4:16 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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