Freshen generated docs, fix the regeneration tooling, and validate links on PRs - #665
Merged
Conversation
Regenerate the plugin-api reference (first regeneration since May 2025; picks up cellFormat and other doc-comment changes), telemetry docs (checkedUpdateAPI moves out of the limited level, matching grist-core), audit-log events, and the keyboard shortcuts page. Restore the title frontmatter that regeneration dropped; mkdocs uses it for nav labels. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Make build-telemetry.sh and build-plugin-api.sh preserve page frontmatter (via a shared helper), and fix build-shortcuts.js, which had rotted: resolve 'app/...' imports via NODE_PATH for both checkout layouts, handle platform-specific command keys, and call the now-localized descriptions with i18next initialized. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Add the cellFormat query parameter to the /records and /data endpoints, and describe the errors field of returned records (readOnly, since the same schema describes PATCH /records request bodies). Link to grist-core's grist-data-format.md for details. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…rsed; add api.md to .gitignore, since it's now produced automatically during publishing
…e in one command Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The i18n hook back-fills untranslated pages from en by resolving nav entries, but skipped awesome-pages wildcard entries, so the plugin-api reference pages were missing from non-en sites: links to them warned during the build, and returned 404s on the published site. Also add the overlooked code/enums to the plugin-api nav wildcards. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
A strict English docs build now runs on PRs, failing on link problems: broken relative links, links in the site-URL form (../../foo/ or /foo/) or to missing anchors (per the raised 'validation' levels), and absolute links to our own site. The absolute-link check runs in a hook, so authors also see the warnings locally in every build or serve. Both build-lang and build-all accept --strict to run the same checks locally. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
paulfitz
approved these changes
Jul 14, 2026
| validate-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 |
Member
There was a problem hiding this comment.
checkout@v4 / setup-python@v5 would be better for a new workflow
…workflows in the repo
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
2 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.
Documentation had drifted from Grist, esp. for plugin API, and the tooling for keeping docs current rotted in places. This PR freshens the content, repairs the tooling, fixes links, and adds some automatic link verifications going forward.
Freshened content:
cellFormatoption,LinkingType, and some other changes), telemetry docs, audit-log events, and keyboard shortcuts.cellFormatquery parameter and theerrorsrecord property in the REST API reference, linking to grist-core'sgrist-data-format.md.Tooling repairs:
build-shortcuts.jsworks again with current Grist code (fixed module resolution, platform-specific keys, localized descriptions).freshen.shruns all regeneration scripts plus a full site build in one command.naventries; the plugin-api pages previously 404'd on/fr/.Validation
validate-docsjob builds the English docs in strict mode on PRs, catching broken relative links, site-URL-style links (../../foo/,/foo/), broken anchors, and absolute links to our own site.docs.py build-lang/build-allaccept--strictoption to run the same checks locally.api.md.