Skip to content

docs: add golden context files for AI agent navigation [TRANS-13]#2555

Merged
david-shibley-contentful merged 2 commits into
mainfrom
chore/add-golden-context-v2
May 8, 2026
Merged

docs: add golden context files for AI agent navigation [TRANS-13]#2555
david-shibley-contentful merged 2 commits into
mainfrom
chore/add-golden-context-v2

Conversation

@david-shibley-contentful
Copy link
Copy Markdown
Contributor

Summary

  • Adds AGENTS.md, ARCHITECTURE.md, and CONTRIBUTING.md to make this repo navigable for AI agents and new engineers without a human guide
  • AGENTS.md covers ownership, structure, sharp edges, and never/always rules
  • ARCHITECTURE.md documents the PostMessage SDK, UMD build pipeline, dual-publish setup (@contentful/app-sdk + contentful-ui-extensions-sdk), and extension lifecycle
  • CONTRIBUTING.md documents the dev workflow, test conventions (Mocha + jsdom), and release process

This replaces #2554 which accidentally included unrelated GitHub Packages migration commits in the branch.

Test plan

  • Verify files render correctly on GitHub
  • Spot-check that repo paths and commands referenced in the docs are accurate

Generated with Claude Code

Adds AGENTS.md, ARCHITECTURE.md, and CONTRIBUTING.md to make this repo
navigable for AI agents and new engineers without a human guide.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@david-shibley-contentful david-shibley-contentful requested review from a team as code owners May 7, 2026 19:14
@david-shibley-contentful
Copy link
Copy Markdown
Contributor Author

This is a replacement for #2554 which accidentally included two pre-existing GitHub Packages migration commits in the branch (not intentional — branch was cut before those landed on master). This new PR is based cleanly off master and contains only the golden context docs. Apologies for the noise on the original!

@david-shibley-contentful david-shibley-contentful changed the title docs: add golden context files for AI agent navigation docs: add golden context files for AI agent navigation [TRANS-00] May 7, 2026
@david-shibley-contentful david-shibley-contentful changed the title docs: add golden context files for AI agent navigation [TRANS-00] docs: add golden context files for AI agent navigation [TRANS-13] May 7, 2026
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💛

@david-shibley-contentful david-shibley-contentful merged commit 184bc1b into main May 8, 2026
13 checks passed
@david-shibley-contentful david-shibley-contentful deleted the chore/add-golden-context-v2 branch May 8, 2026 18:32
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.

2 participants