Skip to content

docs: update references to Flatcar in documentation style guide and help enforce is using custom instructions for Copilot#550

Open
John15321 wants to merge 2 commits intomainfrom
john15321/refactor-doc-style-guide
Open

docs: update references to Flatcar in documentation style guide and help enforce is using custom instructions for Copilot#550
John15321 wants to merge 2 commits intomainfrom
john15321/refactor-doc-style-guide

Conversation

@John15321
Copy link
Copy Markdown
Member

@John15321 John15321 commented Mar 31, 2026

Add VS Code custom instructions for Copilot to enforce Flatcar documentation conventions automatically. This includes a project-wide copilot-instructions.md covering naming, file extensions, and Hugo structure, plus a docs-specific flatcar-docs.instructions.md that applies the style guide rules (impersonal tone, ATX headings, asterisk bullets, reference-style links, sentence case, fenced code blocks) whenever Copilot edits files under docs. Also fixes several issues in the existing style guide: missing .md suffix, broken Styles.png image reference, stale CoreOS references, and an incorrect anchor link.

@github-actions
Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-550.westeurope.1.azurestaticapps.net

1 similar comment
@github-actions
Copy link
Copy Markdown

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-550.westeurope.1.azurestaticapps.net

@John15321
Copy link
Copy Markdown
Member Author

@John15321 John15321 marked this pull request as ready for review March 31, 2026 12:07
@John15321 John15321 requested a review from a team as a code owner March 31, 2026 12:07
@John15321 John15321 changed the title docs: update references to Flatcar in documentation style guide docs: update references to Flatcar in documentation style guide and help enforce is using custom instructions for Copilot Apr 2, 2026
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
Signed-off-by: Jan Bronicki <janbronicki@microsoft.com>
@John15321 John15321 force-pushed the john15321/refactor-doc-style-guide branch from 2ecce94 to 771e378 Compare April 2, 2026 10:40
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-550.westeurope.1.azurestaticapps.net

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant