Skip to content

docs: add architecture, terminology, and style guidance to CLAUDE.md and AGENTS.md#5983

Merged
bastienbeurier merged 2 commits into
masterfrom
claude/vibrant-moore-edd2e1
Apr 29, 2026
Merged

docs: add architecture, terminology, and style guidance to CLAUDE.md and AGENTS.md#5983
bastienbeurier merged 2 commits into
masterfrom
claude/vibrant-moore-edd2e1

Conversation

@bastienbeurier
Copy link
Copy Markdown
Member

Summary

  • Extends docs/CLAUDE.md with 6 new sections extracted from a shared agent prompt used for docs restructuring work
  • Creates docs/AGENTS.md with identical content so Codex follows the same conventions as Claude

New sections in both files:

  • Docs architecture — use cases = orientation only, functions = technical source of truth, keep both groups flat
  • Terminologyfunctions as the core primitive; actions/syncs only when the type distinction matters
  • Content style — no AI slop, walls of text, or duplicated explanations; concise and targeted
  • Agent accordions — when and how to add programmatic-alternative accordions in step-by-step guides
  • Workflow for restructuring — 8-pass approach with live docs comparison requirement

Test plan

  • No functional code changed — docs guidance files only
  • mintlify broken-links is unaffected (no MDX pages or links modified)

🤖 Generated with Claude Code

…and AGENTS.md

Extracts docs restructuring intent from a shared agent prompt into persistent
guidance files so Claude and Codex both follow the same conventions without
needing the full prompt each time.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 29, 2026

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

Project Status Preview Updated (UTC)
nango 🟢 Ready View Preview Apr 29, 2026, 10:04 AM

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

Copy link
Copy Markdown

@nango-repository-pusher nango-repository-pusher Bot left a comment

Choose a reason for hiding this comment

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

✅ Auto-approved: docs-only change.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Copy link
Copy Markdown

@nango-repository-pusher nango-repository-pusher Bot left a comment

Choose a reason for hiding this comment

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

✅ Auto-approved: docs-only change.

@bastienbeurier bastienbeurier added this pull request to the merge queue Apr 29, 2026
Merged via the queue into master with commit 38c7beb Apr 29, 2026
25 checks passed
@bastienbeurier bastienbeurier deleted the claude/vibrant-moore-edd2e1 branch April 29, 2026 10:17
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