[Docs] README and AGENTS updates: Split docs by audience (plugin authors vs framework contributors)#47
Merged
Conversation
- Root README: steer plugin authors to the build-your-first-plugin scaffolding guide (direct installs are rarely needed) and add a Developing pointer to each package's instructions - Package READMEs: separate "Using" sections for plugin authors from "Developing" sections with brief monorepo setup (lerna bootstrap/build), the install-in-place workflow (per-package scope, cross-package ordering), and the lockstep release flow - Fix react-ui README title and install snippets, which referred to datocms-plugin-sdk instead of datocms-react-ui - Rename packages/react-ui/CLAUDE.md to AGENTS.md (cross-tool standard) and add the missing first-time monorepo setup steps to it - Add a root AGENTS.md with monorepo-wide guidance for coding agents - Use absolute GitHub URLs throughout, since package READMEs are published to npm where relative links break Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
roger-datocms
changed the title
Member
|
I'm not the best person to review this. I'll leave it to @stefanoverna for when he can |
stefanoverna
approved these changes
Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documentation-only pass over the monorepo's READMEs and agent guides:
datocms-plugin-sdk,datocms-react-ui) — split into a "Using" section for plugin authors and a "Developing" section for contributors: monorepo setup (lerna bootstrap/lerna run build), theinstall-in-placeworkflow for testing changes inside a real plugin (including its per-package scope and the sdk-before-react-ui ordering), and the lockstep release flow.datocms-plugin-sdk— a copy-paste from the sdk's README that's been wrong since the file was created.packages/react-ui/CLAUDE.md→AGENTS.md(the cross-tool standard) and added the missing first-time-setup steps; added a small rootAGENTS.mdwith monorepo-wide guidance.Why
The old READMEs documented the packages as if they were standalone installs, with nothing about how the monorepo actually builds, how the two packages interdepend, or how to test changes against a real plugin — knowledge that otherwise has to be rediscovered by trial and error.
🤖 Generated with Claude Code