docs: revise plugin configuration files guide wording#2
Open
lvojtku wants to merge 2 commits into
Open
Conversation
Tighten the Configuration Layering section of the plugin configuration files guide: remove hedged, padded phrasing in the intro and summary paragraphs without changing the documented merge/precedence semantics. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
github-actions
Bot
added
size:S
documentation
Cherry-pick the wording revisions from b974162 onto the tech-writer edits. Excludes the Shortest Path Example section (belongs to the integration-example-coverage branch, not this PR's base) and keeps the more-direct Configuration Layering paragraph from this branch. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Linette Tang <lvojktu@nvidia.com>
lvojtku
changed the title
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
1 participant
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.
Overview
Editorial pass over the plugin configuration files guide (
docs/build-plugins/plugin-configuration-files.mdx). Combines a focused "make the Configuration Layering language more direct" change with a broader wording revision of the rest of the page. Documentation only — no behavior, config schema, or merge/precedence semantics change.Details
Two commits, both touching only
docs/build-plugins/plugin-configuration-files.mdx:c86a041— tightened the Configuration Layering section: removed hedged/padded phrasing in the intro and summary paragraphs.f49f885— broader wording revision across the page: tutorial-voice intro, Discovery reformatted as a bulleted list, clearer field-default descriptions, and assorted phrasing edits. Includes typo/grammar corrections (adaptive,declare, and theOrdered/Registered/Disabledfield descriptions).The same-paragraph overlap in Configuration Layering was resolved in favor of the more-direct wording. Edits that targeted the
Shortest Path Example/What Success Looks Likesections were excluded, since those sections do not exist on this branch's base.Where should the reviewer start?
docs/build-plugins/plugin-configuration-files.mdx— review the full rendered diff. Confirm the wording reads clearly and that no documented merge/precedence/validation behavior changed.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)