-
Notifications
You must be signed in to change notification settings - Fork 5
New input documentation #492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…n/platform-documentation into input-validation-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces dedicated “what is” documentation for each input type, updates existing guides and changelogs to point to those new pages, and enhances the CloudCannon configuration with input validation, a new reference collection, and commit template requirements.
- Added new MDX articles under
articles/
(e.g.,what-is-a-*
) for each input type. - Updated all existing guides, changelogs, and references to use the new documentation paths.
- Extended
cloudcannon.config.cjs
with:
• A Date input icon
• An_inputs
block to requiretitle
on article-instructions
• A newreference
collection schema
• Enhancedcommit_templates
schema with required message input
Reviewed Changes
Copilot reviewed 187 out of 191 changed files in this pull request and generated no comments.
File | Description |
---|---|
guides/unified-configuration-migration-guide/input-configuration.mdx | Updated Select input link to new “what-is” docs |
cloudcannon.config.cjs | Added Date icon, _inputs validation, new reference schema, commit templates |
articles/what-is-*.mdx (many files) | New standalone articles for each input type |
Comments suppressed due to low confidence (2)
guides/unified-configuration-migration-guide/input-configuration.mdx:25
- The anchor
#options
may not exist in the newwhat-is-a-select-input
page—verify that the header in that doc is exactlyOptions
so the fragment link resolves correctly.
Before Unified Configuration, CloudCannon could use build data to populate the <a href="/documentation/articles/what-is-a-select-input/#options" target="_blank" rel="noopener">Select and Multiselect input</a> option `value_key` values. As a successful build is no longer required to edit your files, you must define all values for the `value_key` option in the configuration cascade rather than use values generated by a build integration.
cloudcannon.config.cjs:241
- The
_inputs
entry for"$.title"
specifiesoptions
but omits atype
(e.g.type: text
). Without atype
, CloudCannon may not recognize the input configuration—addtype
alongsideoptions
.
_inputs: {
DO NOT MERGE until after input validation and updated URL inputs go to main