docs(external-creds): rename and regroup H3 sections#1388
Merged
Conversation
Renames generic H3 names and groups related subsections, without changing the content of the sections themselves. Renames: - `Detailed description of objects` -> `Objects`. - `Effective Set external credential behavior` -> `Effective Set generation`. Regrouping: - New `Environment Instance generation` H3 wraps `Repository credentials mode` and `Credential sources and merging` (both demoted to H4). This mirrors the existing `Effective Set generation` H3 that groups generation-time algorithms. - `Deciding between VALS and ESO references` is moved from a sibling H3 to a H4 under `Effective Set generation` (it is part of the generation decision logic). - Section order: `Overview`, `Objects`, `Environment Instance generation`, `Effective Set generation`. Anchors: - `#detailed-description-of-objects` -> `#objects`. - `#effective-set-external-credential-behavior` -> `#effective-set-generation`. - Other section anchors are text-based and remain unchanged across level demotions. Cross-references in `docs/features/calculator-cli.md` to the renamed `#effective-set-external-credential-behavior` anchor are updated to `#effective-set-generation`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Cleanup of generic H3 section names and grouping in
docs/features/external-creds.md. Content of the sections themselves is unchanged.Renames
Detailed description of objects->Objects.Effective Set external credential behavior->Effective Set generation.Regrouping
Environment Instance generationH3 wrapsRepository credentials modeandCredential sources and merging(both demoted to H4). Mirrors the existingEffective Set generationH3 that groups generation-time algorithms.Deciding between VALS and ESO referencesis moved from a sibling H3 to a H4 underEffective Set generation(it is part of the generation decision logic).Overview,Objects,Environment Instance generation,Effective Set generation.Anchors
#detailed-description-of-objects->#objects.#effective-set-external-credential-behavior->#effective-set-generation.Cross-references in
docs/features/calculator-cli.mdto the renamed#effective-set-external-credential-behavioranchor are updated to#effective-set-generation.Test plan
npx --yes markdownlint-cli@latest --config .github/linters/.markdown-lint.yml docs/features/external-creds.md docs/features/calculator-cli.mdpasses#objects,#effective-set-generation,#environment-instance-generationresolvesgrep -rn "detailed-description-of-objects\|effective-set-external-credential-behavior" docs/returns empty)🤖 Generated with Claude Code