Repository navigation
docs: fold dynamic parameters into a Parameters section - #30912
Open
coder[bot] wants to merge 1 commit into
Open
coder[bot] wants to merge 1 commit into
coder[bot] wants to merge 1 commit into
Conversation
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.
Contributor
This branch has not been deployed
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.
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
parameters/index.md(Parameters)parameters.md+ intro/requirements/data-source sections ofdynamic-parameters.mdparameters/form-types.mdform_typetable,stylingtable, an example for each form typedynamic-parameters.mdparameters/validation.mdparameters.md+ "Dynamic Validation"parameters/conditional-parameters.mddynamic-parameters.mdparameters/identity-aware-parameters.md(state: [premium])dynamic-parameters.mdparameters/workspace-presets.mdparameters.mdparameters/compatibility-mode.mddynamic-parameters.mdparameters/troubleshooting.mddynamic-parameters.mdparameters.mdmoves toparameters/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-parametersredirects to the Parameters section.docs()links that pointed atdynamic-parametersnow point atparameters, or atparameters/compatibility-modewhere the link is about compatibility mode (the Storybook assertion is updated to match).Not in this PR
Dashboard UI copy still says "Dynamic Parameters" in a few tooltips and helper text (for example,
CreateWorkspacePageView.tsxandTemplateParametersPageView.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: passmarkdownlint-cli2andmarkdown-table-formatter --checkon changed docs: passbiome checkon the changedsite/files: passparameters.mdanddynamic-parameters.mdwith the new pages: all 33 are present.glossary.mdandadmin/templates/index.md, which this PR doesn't touch.This PR was drafted by Superblink (Coder's AI assistant) at the request of @stirby, who will review it and is accountable for it.