Skip to content

docs: fold dynamic parameters into a Parameters section - #30912

Open
coder[bot] wants to merge 1 commit into
mainfrom
docs/merge-dynamic-parameters
Open

coder[bot] wants to merge 1 commit into
mainfrom
docs/merge-dynamic-parameters

Conversation

@coder

@coder coder Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Dynamic parameters are how every parameter works now (default since v2.25.0), but the docs still split the concept across two sibling sidebar pages, "Parameters" and "Dynamic parameters". That hides form types, conditional parameters, and identity-aware parameters behind a legacy feature name.

This PR folds them into a single Parameters section under Extend templates, with one focused child page per concept. Every code example from both old pages is kept (33 of 33 fenced blocks, including the commented-out daisy-chaining example).

New structure

Page Contents Came from
parameters/index.md (Parameters) What parameters are, defining one, provider version, how Coder evaluates parameters (data source caching, no HTTP fetching), types, options, required/optional, mutability, ephemeral, URL autofill parameters.md + intro/requirements/data-source sections of dynamic-parameters.md
parameters/form-types.md form_type table, styling table, an example for each form type dynamic-parameters.md
parameters/validation.md Number and string validation, validation that depends on other parameters parameters.md + "Dynamic Validation"
parameters/conditional-parameters.md Show/hide, defaults from other parameters dynamic-parameters.md
parameters/identity-aware-parameters.md (state: [premium]) Role-aware options, group-aware regions, groups as namespaces dynamic-parameters.md
parameters/workspace-presets.md Presets parameters.md
parameters/compatibility-mode.md Find, upgrade, and revert compatibility-mode templates dynamic-parameters.md
parameters/troubleshooting.md Known issues, template variables, registry modules, module-not-loaded errors dynamic-parameters.md

parameters.md moves to parameters/index.md, so /docs/admin/templates/extending-templates/parameters (and #ephemeral-parameters, which the dashboard links to) keeps working.

Other changes

  • docs/redirects.json: /docs/admin/templates/extending-templates/dynamic-parameters redirects to the Parameters section.
  • Dashboard docs() links that pointed at dynamic-parameters now point at parameters, or at parameters/compatibility-mode where the link is about compatibility mode (the Storybook assertion is updated to match).
  • Inbound doc links updated. Glossary gets a Parameters entry, and Dynamic parameters is kept as the former name.
  • Tabs on the old page are replaced with headed sections, per the style guide's rule against tabs for content every reader needs. Each form type and example now has its own anchor.
  • Small cleanups in moved prose: sentence-case headings, "Dynamic Parameters" product-name references removed, the stale "Later in 2025..." registry-module sentence and GA announcement copy dropped, "template creation links" corrected to "workspace creation links" for URL autofill.

Not in this PR

Dashboard UI copy still says "Dynamic Parameters" in a few tooltips and helper text (for example, CreateWorkspacePageView.tsx and TemplateParametersPageView.tsx). That's a product copy change and is better handled separately.

Verification

  • make gen/docs-manifest, make lint/docs-manifest, make lint/docs-redirects (also with -base origin/main), make lint/emdash, make lint/docs-html: pass
  • markdownlint-cli2 and markdown-table-formatter --check on changed docs: pass
  • Vale on the new pages: 0 errors, 0 warnings, 0 suggestions
  • biome check on the changed site/ files: pass
  • A script compared every fenced code block in the old parameters.md and dynamic-parameters.md with the new pages: all 33 are present.
  • Relative links and anchors in all changed docs files resolve. The only failures are anchors that were already broken in glossary.md and admin/templates/index.md, which this PR doesn't touch.
  • Not done: a rendered preview on the docs site, and running the Storybook interaction test.

This PR was drafted by Superblink (Coder's AI assistant) at the request of @stirby, who will review it and is accountable for it.

Dynamic parameters are the default parameter experience, so a separate page splits one concept across two sidebar entries. Move parameters.md to parameters/index.md and split the parameter content into focused child pages, keeping every code example. Add a redirect for the old dynamic-parameters URL and update inbound links in docs and the dashboard.
@coder
coder Bot requested a review from nickvigilante as a code owner October 17, 2026 00:40
@coder coder Bot assigned stirby Oct 17, 2026
@github-actions github-actions Bot added the community Pull Requests and issues created by the community. label Oct 17, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant