[docs] docs: condense faq.md - remove verbose and repetitive content#18237
Merged
[docs] docs: condense faq.md - remove verbose and repetitive content#18237
Conversation
- Determinism section: collapse 4 paragraphs to 2 (removed redundant "Continuous AI trifecta" elaboration and trailing restatement) - Lock file section: collapse 5 paragraphs to 2 (removed three repetitions of the same markdown-vs-frontmatter recompile rule) - PR creation failure section: replace verbose Option 1/2/3 framing with compact inline descriptions, removing ~30 lines of boilerplate Net: -47 lines (-13% by line count; higher % by word count) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
This was referenced Feb 25, 2026
pelikhan
approved these changes
Feb 25, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Condenses repetitive prose in the FAQ documentation while keeping the same technical guidance and links.
Changes:
- Shortened the determinism FAQ answer while keeping the “agentic workflows are additive” guidance.
- Condensed the workflow lock file explanation into a tighter definition plus a two-item commit guidance list.
- Reworked the “create-pull-request blocked by org policy” section into a compact set of alternatives.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| When the workflow runs, the prompt itself is taken from the markdown file at runtime, so you can edit the markdown without recompiling and see changes in the next run. However, any changes to frontmatter (permissions, tools, triggers) require recompilation to update the lock file. | ||
| - **`.md` file**: Your source - edit the prompt body freely; changes take effect at the next run without recompiling | ||
| - **`.lock.yml` file**: The compiled workflow GitHub Actions actually runs; must be regenerated after any frontmatter changes (permissions, tools, triggers) |
There was a problem hiding this comment.
The parenthetical examples of frontmatter changes that require recompilation omit some fields (e.g., network rules) and reads slightly inconsistent with the earlier FAQ entry that lists tools/permissions/triggers/network rules as requiring recompilation. Consider either stating “any frontmatter changes” without enumerating, or expanding the list to include network (and other key frontmatter-driven settings).
Suggested change
| - **`.lock.yml` file**: The compiled workflow GitHub Actions actually runs; must be regenerated after any frontmatter changes (permissions, tools, triggers) | |
| - **`.lock.yml` file**: The compiled workflow GitHub Actions actually runs; must be regenerated after any frontmatter changes |
| Some organizations block PR creation by GitHub Actions via **Settings → Actions → General → Workflow permissions**. If you can't enable it, use one of these alternatives: | ||
|
|
||
| **Workaround Options:** | ||
| **Automatic issue fallback (default)** — `fallback-as-issue: true` is the default; when PR creation is blocked an issue with the branch link is created instead. Requires `contents: write`, `pull-requests: write`, and `issues: write`. |
There was a problem hiding this comment.
Minor grammar: in “when PR creation is blocked an issue…”, add a comma after “blocked” to avoid a run-on clause.
Suggested change
| **Automatic issue fallback (default)** — `fallback-as-issue: true` is the default; when PR creation is blocked an issue with the branch link is created instead. Requires `contents: write`, `pull-requests: write`, and `issues: write`. | |
| **Automatic issue fallback (default)** — `fallback-as-issue: true` is the default; when PR creation is blocked, an issue with the branch link is created instead. Requires `contents: write`, `pull-requests: write`, and `issues: write`. |
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.
Reduces bloat in
docs/src/content/docs/reference/faq.mdby condensing three sections with repetitive or excessively verbose prose.File improved
docs/src/content/docs/reference/faq.md(357 → 310 lines, −47 lines / −13%)Changes made
Determinism section (4 paragraphs → 2)
Workflow lock file section (5 paragraphs → 2)
PR creation failure workarounds (~55 lines → ~25 lines)
[!TIP]callout that restated the default behaviour already shown in the listWhat was preserved
All technical accuracy, code examples, external links, and actionable guidance were retained. No information was removed — only redundant restatements.
Screenshots
Screenshots could not be captured: the Playwright container runs with network isolation that prevents it from reaching the local preview server (both
localhostand the direct host IP returnedERR_CONNECTION_REFUSED/ timeout). The docs build completed successfully (124 page(s) built) and all internal links validated cleanly.References