Repository navigation
docs: integration branch for shipped features through 3.17.2 (do not squash) - #183
Merged
Merged
Conversation
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Notes has shipped since decap-cms 3.15.0 but was never documented, so the only way to find `editor.notes` was to read the source. Covers what a note is, enabling it globally or per collection, using the pane, and how notes are stored — as comments on an issue the CMS opens per entry, with the resolution status and author in an HTML comment the host renders invisibly. Documents the things that are surprising in use rather than only the happy path: notes need the editorial workflow and a saved entry, only the author of a note can act on it, the pane shares one space with preview and i18n, and a note is as public as the repository is. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Resolve the editor section against #175 (notes): list preview, notes and visualEditing together. visualEditing is read only from a collection's own editor settings, so say so. The site config set preview.visualEditing, which the CMS ignores; use editor.visualEditing. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Added in decap-cms 3.12 (decaporg/decap-cms#7766). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Added in decap-cms 3.12.2 (decaporg/decap-cms#6220). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Shipped in decap-cms 3.15 (decaporg/decap-cms#6675) and registered by default, but never documented. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Added to the markdown widget in decap-cms 3.16.2 (decaporg/decap-cms#7958). The example avoids Hugo shortcode syntax, which this site's own Hugo build would try to expand. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Both changed in decap-cms 3.17.2 (decaporg/decap-cms#8006, #7989). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
decap-cms 3.17.2 stopped evaluating it (a2b0ae153). Such a file loads empty, so warn that saving it overwrites the file. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- decap-server 3.11.6 listens on this machine only by default; say so, and explain how to reach it from another device. - The editorial workflow works with MODE=git; document MODE, GIT_REPO_DIRECTORY and LOG_LEVEL, and warn that git mode commits everything in the working tree (it runs git add .). - Node.js 20 is required. - Fix the .env example (BIND_HOST=8082), the header name (Access-Control-Allow-Origin) and npm run start in user examples. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Listed with status badges since decap-cms 3.8 (decaporg/decap-cms#7495), under their own sorted heading since 3.15 (#7624). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Slovak, Croatian, Serbian and Macedonian were added recently, and the docs never said which locale codes exist. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Neon's storage:write scope includes reads and listing; drop the false reason, and say public_url_prefix goes in config.yml, not variables. - Notes shipped in 3.15 (GitHub), gained GitLab in 3.16.3 and Turbo in 3.17. The issue link appears once there are notes. authorId decides ownership only on Turbo, where author can be the editor's email. - Revert the docs.js preview change from #138: the preview entry is already stega-encoded with visual editing on, and widgetFor('title') put a margined div inside the h1. - Field-level visualEditing: false arrived in 3.7. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Forgejo: the editorial workflow needs 3.16.2 (decaporg/decap-cms#7976) and open authoring with a renamed fork 3.17.2 (#8013); no labels in open authoring. - The slug byte cap is lower for long collection names. - preview_context also works on turbo-github and turbo-gitlab; branch defaults to main and api_root is required on Forgejo. - git-gateway and Decap Turbo support the editorial workflow too. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Grouped collections list unpublished entries once, below the groups, and view filters don't apply to them; the heading and sorting are 3.15. - ORIGIN allows one origin; custom host names also need allowed_hosts; note the decap-server 3.11.6 bind default next to BIND_HOST. - signoff_commits: no trailer on the publish merge commit, none on Bitbucket. - preview_path_preserve_slashes: edge slashes are removed, and a file-level setting is ignored. - Describe what an inline component trigger actually speeds up. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Neon Object Storage needs no special handling, so instead of naming it throughout the page and on the feature page, describe the variables generically and list each provider's values in one section at the bottom: AWS S3, Bunny Storage, Cloudflare R2 and Neon, alphabetically. The feature page goes back to its text on main. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This was referenced Oct 26, 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
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.
Brings the docs up to date with what has shipped in
decap-cmsup to 3.17.2: merges the open docs PRs whose features are released, and documents recent changes that never made it into the docs.Merge with a merge commit, not a squash, so the four merged PRs keep their authors and are marked as merged.
Merged PRs
Fixes applied on top, after checking each claim against the
decap-cmssource:editorsection. The site config setpreview: visualEditing, which the CMS ignores; it's noweditor: visualEditing. Reverted thedocs.jschange, since the preview entry is already encoded for visual editing andwidgetFor('title')put a margineddivinside theh1.authorIddecides ownership only on Turbo, whereauthorcan be the editor's email; the issue link appears once the entry has notes.storage:writescope already includes read and list;public_url_prefixgoes inconfig.yml, not in site variables.preview_contextalso works onturbo-githubandturbo-gitlab; Forgejo'sbranchandapi_rootdefaults; Git Gateway and Decap Turbo support the editorial workflow.Newly documented
backend.signoff_commits(3.12, feat: add config option to enable Signed-off-by in commit messages decap-cms#7766)preview_path_preserve_slashes(3.12.2, feat: allow special characters to pass through slugification decap-cms#6220)uuidwidget, registered by default since 3.15 (feat: add uuid widget decap-cms#6675)filterson list fields (fix(relation): match filters against multiple-value fields decap-cms#8006) andpreSavereturning a whole entry (fix(core): preserve full entries returned by preSave handlers decap-cms#7989), both 3.17.2sk,hr,sr_CyrlandmkMODE=gitand the editorial workflow (with a warning that git mode commits everything in the working tree),GIT_REPO_DIRECTORY,LOG_LEVEL, Node.js 20, reaching the proxy from another device, and the brokenBIND_HOST=8082exampleNot included
These docs PRs wait for
decap-cmsPRs that are still open: #180 (decaporg/decap-cms#8036), #178 (decaporg/decap-cms#8012), #177 (decaporg/decap-cms#7999), #176 (decaporg/decap-cms#7984), #157 (decaporg/decap-cms#7382), #92 (decaporg/decap-cms#7329), #85 (decaporg/decap-cms#7310), #76 (decaporg/decap-cms#7031), #61 (decaporg/decap-cms#6836), #60 (decaporg/decap-cms#6469). #172, #148 and #104 don't document a shipped feature.Testing
hugo --gc --minifybuilds with no new warnings (Hugo 0.166 locally; Netlify pins 0.148.1, so the deploy preview is the real check)./docs/link and anchor added on this branch resolves in the build output.🤖 Generated with Claude Code