Docs: add any feature gaps#409
Merged
Merged
Conversation
- Add StatusPageController to generated page docs (metadata, fixture, preview with reference number panel) - Add app-no-prose to all generated previews by default; add wrapperClass hook to page preview generator for future overrides - Fix union type pipe escaping in generated configuration tables - New hand-written pages: form-definition-options (sections, declaration, phaseBanner, showReferenceNumber, referenceNumberPrefix) - Rewrite custom-services to document all three service interfaces with TypeScript signatures; add output.audience/version; clarify Defra Forms submission API scope - Rewrite pre-populate-state with accurate mechanics (QuestionPageController, global HiddenField scan, GET param forwarding) and working examples - Expand plugin-options cache section to cover CacheService instance path; collapse saveAndExit to a signpost - Expose form-definition-options in docusaurus nav under Reference - Add AGENTS.md with generated-vs-handwritten docs guidance and app-no-prose convention
…ages - Move globals + filters out of plugin-options into features/code-based/template-extensions, with built-in filters table and LiquidJS cross-reference - Move cache setup out of plugin-options into session-cache, clarifying named catbox cache (simple) vs CacheService subclass (full lifecycle override) - Collapse both plugin-options sections to signposts - Add template-extensions to code-based index - Expose session-cache in Reference nav sidebar
Move form definition formats and session cache under features/code-based, move form definition options under features, and restore page elements as a top-level feature. Add lists documentation to form definition options. Reference section now contains only the request lifecycle.
jbarnsley10
reviewed
May 19, 2026
jbarnsley10
reviewed
May 19, 2026
jbarnsley10
reviewed
May 19, 2026
jbarnsley10
reviewed
May 19, 2026
| ### User feedback | ||
|
|
||
| `options.disableUserFeedback` — when `true`, the "What do you think of this service?" feedback link is suppressed on all pages, including the confirmation page. Defaults to `false`. | ||
|
|
Contributor
There was a problem hiding this comment.
Do we need to add that it reverts to a 'mailto', and where the mail link comes from?
Contributor
Author
There was a problem hiding this comment.
just did a bit of digging and it's a bit more complicated than i thought. i'll come back to this separately.
jbarnsley10
approved these changes
May 19, 2026
Contributor
jbarnsley10
left a comment
jbarnsley10
left a comment
There was a problem hiding this comment.
Very thorough. A couple fo minor comments but approving anyway.
Adds a named componentSecrets feature to the doc generation script so components can declare what per-form secrets they require. Generates a standard "Required secrets" section with a getFormSecret blurb and a secrets table. PaymentField is the first consumer. Also clarifies in custom-services.md that getFormSecret is per-form scoped, distinct from global plugin options such as ordnanceSurveyApiKey, and safe to leave unimplemented when no secret-using components are present.
|
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.
Proposed change
Patches some gaps in documentation we have.
Jira ticket:
Type of change
Checklist
README.mdanddocs/*(where appropriate, e.g. new features).npm run test).npm run lint).npm run format).