Repository navigation
docs: fix React 19 script-tag install, normalize package metadata, add AGENTS.md and context7.json - #8092
Open
martinjagodic wants to merge 4 commits into
Open
docs: fix React 19 script-tag install, normalize package metadata, add AGENTS.md and context7.json#8092martinjagodic wants to merge 4 commits into
martinjagodic wants to merge 4 commits into
Conversation
The decap-cms-app README loaded React 18 UMD builds next to a decap-cms-app bundle that now expects React 19, which ships no UMD builds. Pointed script-tag users at the self-contained decap-cms bundle instead, kept decap-cms-app for bundler installs, and listed the S3 media library among the extensions it leaves out.
Every published package now declares its repository as the monorepo git URL with a `directory`, instead of a GitHub tree URL (one of which still pointed at `master`). Packages without a homepage get their README on GitHub; existing decapcms.org homepages are kept.
AGENTS.md gives coding agents the layout, commands, commit format, catalog rules and release process, linking to CONTRIBUTING.md for the rest. context7.json points Context7 at the package READMEs and away from changelogs, contributor docs, tests and CI files, and adds a few usage rules.
https://www.decapcms.org/docs/quick-start/ is a redirect page that forwards to /docs/basic-steps/. Link the target instead.
✅ Deploy Preview for decap-cms ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
6 tasks done
This branch has not been deployed
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
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.
Fixes setup snippets and metadata that people and AI coding agents copy from the README, npm and Context7.
Changes
1. Script-tag install in the
decap-cms-appREADME (React 19)The README loaded
react@^18UMD builds next todecap-cms-app. The currentdecap-cms-apppeer-depends on React 19, and React 19 ships no UMD builds (https://cdn.jsdelivr.net/npm/react@19/umd/react.production.min.jsreturns 404). The old snippet as written is broken too: in Chrome it throwsTypeError: Cannot read properties of undefined (reading 'S')and thenDecapCmsApp is not defined.decap-cms-appis for npm installs with a bundler (npm i decap-cms-app react react-dom).decap-cmsbundle, which includes React and exposeswindow.CMS. The example useswindow.CMS_MANUAL_INITplusCMS.init(), matching the old snippet's manual init, and mentionswindow.handwindow.createClass. All of these are set inpackages/decap-cms/src/index.js.decap-cms-appleaves out.decap-cmsregisters it insrc/extensions.js;decap-cms-appdoesn't.No other README or doc in this repo had the
umd/reactpattern.2. package.json metadata (47 packages)
repositoryis now{"type": "git", "url": "git+https://github.com/decaporg/decap-cms.git", "directory": "packages/<dir>"}everywhere. Before, it was a/tree/main/...URL, or/tree/master/...fordecap-cms-widget-richtext.https://www.decapcms.orgondecap-cmsanddecap-cms-app, and the per-widget docs anchors on the widgets. The 28 packages with no homepage now point at their README on GitHub.bugswas alreadyhttps://github.com/decaporg/decap-cms/issueseverywhere.catalog:/workspace:specifiers.3.
AGENTS.mdA short guide for coding agents, built from the root
package.jsonscripts,pnpm-workspace.yaml,lerna.json, commitlint/husky, the CI and publish workflows, and CONTRIBUTING. It covers:lerna publish"/llms.txt,/llms-full.txt)It links to CONTRIBUTING.md instead of repeating it.
4.
context7.jsonContext7 currently surfaces CONTRIBUTING and release internals as the top install snippets. This file uses only the fields in Context7's published schema (https://context7.com/schema/context7.json):
projectTitle,descriptionfolders: ["packages"]. The root README is always included.excludeFolders:.github,dev-test,cypress,scripts,__tests__,__fixtures__,__mocks__,dist,node_modulesexcludeFiles: CHANGELOG, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, AGENTS, LICENSE, PR templaterulesNo
previousVersions.5. Quick start link
https://www.decapcms.org/docs/quick-start/is a meta-refresh page that forwards to/docs/basic-steps/. The root README and thedecap-cmspackage README now linkhttps://decapcms.org/docs/basic-steps/directly.Verification
curl:decap-cms@^3.0.0/dist/decap-cms.js(3.18.0),/docs/,/docs/basic-steps/,/llms.txt,/llms-full.txt.test-repoconfig:CMS_MANUAL_INIT,CMS.init()brings up the CMS.CMS.registerPreviewTemplatewith a template written usingwindow.hrenders in the preview pane.package.jsonfiles parse.pnpm install --frozen-lockfile --offlinereports "Already up to date".pnpm run test:package-integritypasses.context7.jsonvalidates against Context7's JSON schema with ajv.prettier --checkpasses onAGENTS.mdandcontext7.json. The repo's lint and format scripts don't cover Markdown or JSON.Note for the next release
lerna.jsonignores*.mdchanges but notpackage.jsonchanges. So the metadata commit marks every package as changed, and the nextlerna versionwill bump all 47 packages, at least by a patch.