Skip to content

Update Forms 16/17/18 docs to match current codebase#8130

Merged
sofietoft merged 3 commits into
mainfrom
forms/docs-codebase-audit
Jun 8, 2026
Merged

Update Forms 16/17/18 docs to match current codebase#8130
sofietoft merged 3 commits into
mainfrom
forms/docs-codebase-audit

Conversation

@rickbutterfield
Copy link
Copy Markdown
Contributor

Summary

Audit of the Forms documentation against the Forms codebase (v17.4.0 working tree, plus the v16/dev branch for version 16 checks). Fixes out-of-date content across the 16, 17, and 18 Forms docs.

Code samples that no longer compile

  • WorkflowType.ExecuteExecuteAsync returning Task<WorkflowExecutionStatus> (adding-a-type, customize-default-workflows)
  • FieldPreValueSourceType.GetPreValuesGetPreValuesAsync(Field?, Form?) (adding-a-prevaluesourcetype)
  • Export type examples updated for async ExportRecordsAsync and awaited ViewHelper.RenderPartialViewToString; fixed submissions.schema casing
  • IRecordReaderService returns PagedModel<Record>, not PagedResult<Record> (working-with-data)
  • ValidateField override now includes the IFieldTypeStorage parameter
  • Removed v8-era Umbraco.Core.* namespaces and leftover internal Umbraco.Forms.TestSite.* namespaces
  • Old AngularJS setting view aliases (TextField, Pickers.Content) replaced with Umb.PropertyEditorUi.* equivalents
  • Replaced the AngularJS "Backoffice View" instructions in adding-a-type with a pointer to the manifest-based adding-a-fieldtype article

Factual corrections

  • Forms 17/18 run on .NET 10, not .NET 9 (version-specific upgrade notes); 18's notes also referenced "Version 17"
  • Removed UseSemanticFieldsetRendering from configuration docs (setting no longer exists in the codebase)
  • DisallowedFileUploadExtensions default includes js
  • Post as XML workflow: phantom "Headers" setting corrected to "Fields"; added "Default Element For Fields" (also added for Send Form to URL in type-details)
  • SetFormThemeCssFile takes a single path parameter

Missing content

  • Documented the MessageOnSubmitIsHtml setting
  • Added HeaderHtml/BodyHtml/FooterHtml to the Razor email workflow settings in type-details
  • Expanded the list of theme files that can be overridden (verified against the shipped default theme in both v16 and v17)
  • Documented the Analytics Processing health check (17/18 only — not present in v16)
  • Email template and custom markup examples updated to match the shipped templates (RecaptchaEnterprise, autocomplete, ARIA attributes)
  • 16's type-details.md also had empty <summary> tags which are now populated

Notes for reviewers

  • Version 16 changes were verified against the v16/dev branch of the Forms repository — all affected APIs (async signatures, PagedModel, theme files, workflow settings) are identical to v17
  • The 18 version-specific note stating a minimum CMS dependency of 18.0.0 follows the established convention; there is no v18 Forms branch to verify against yet

🤖 Generated with Claude Code

Audit of the Forms documentation against the Forms codebase, fixing
out-of-date content across versions 16, 17, and 18:

Code samples that no longer compile:
- WorkflowType.Execute -> ExecuteAsync returning Task<WorkflowExecutionStatus>
- FieldPreValueSourceType.GetPreValues -> GetPreValuesAsync(Field?, Form?)
- ExportType examples updated for async ExportRecordsAsync and awaited
  ViewHelper.RenderPartialViewToString
- IRecordReaderService returns PagedModel<Record>, not PagedResult<Record>
- ValidateField override now includes the IFieldTypeStorage parameter
- Removed v8-era namespaces (Umbraco.Core.*) and leftover internal
  Umbraco.Forms.TestSite namespaces; fixed submissions.schema casing
- Old AngularJS setting view aliases replaced with Umb.PropertyEditorUi.*
- Replaced AngularJS backoffice view instructions with a pointer to the
  manifest-based field type article

Factual corrections:
- Forms 17/18 run on .NET 10 (not .NET 9)
- Removed UseSemanticFieldsetRendering (no longer exists)
- DisallowedFileUploadExtensions default includes js
- Post as XML: "Headers" setting corrected to "Fields", added
  "Default Element For Fields" (also for Send Form to URL)
- SetFormThemeCssFile takes a single path parameter

Missing content:
- Documented MessageOnSubmitIsHtml setting
- Added HeaderHtml/BodyHtml/FooterHtml to Razor email workflow settings
- Expanded the list of theme files that can be overridden
- Documented the Analytics Processing health check (17/18 only)
- Email template and custom markup examples updated to match the
  shipped templates (RecaptchaEnterprise, autocomplete, ARIA attributes)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 4, 2026

Thanks for opening this PR! 🎉

Quick question: Does this PR include any AI-generated content?

AI tools are absolutely welcome here! We only ask that you follow our AI contribution guidelines to help keep the documentation consistent and trustworthy.

Drop a quick comment to let us know!

Comment thread 16/umbraco-forms/developer/extending/adding-a-type.md Outdated
Comment thread 17/umbraco-forms/developer/extending/adding-a-type.md Outdated
Comment thread 18/umbraco-forms/developer/extending/adding-a-type.md Outdated
Shortened a long sentence in adding-a-type.md across versions 16, 17,
and 18. Remaining Vale findings in these files are on pre-existing
lines not touched by this PR.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sofietoft sofietoft merged commit 7522c70 into main Jun 8, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants