Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 22, 2025

This PR consolidates documentation style guidance from the unbloat-docs workflow into the central documentation.instructions.md file and ensures the technical-doc-writer workflow imports this guidance directly.

Changes Made

1. Enhanced Documentation Instructions

Added a comprehensive "Avoiding Documentation Bloat" section to .github/instructions/documentation.instructions.md that includes:

  • Types of Documentation Bloat: Identifies common bloat patterns including duplicate content, excessive bullet points, redundant examples, verbose descriptions, and repetitive structure
  • Writing Concise Documentation: Provides practical guidelines for consolidating bullet points, eliminating duplicates, condensing text, standardizing structure, and simplifying code samples
  • Before/After Example: Shows concrete transformation from bloated to concise documentation style
  • Documentation Quality Guidelines: Emphasizes preserving meaning, surgical edits, maintaining tone, and local testing

2. Updated Technical Documentation Writer Workflow

Modified .github/workflows/technical-doc-writer.md to import the documentation guidance directly from the instructions directory:

imports:
  - ../instructions/documentation.instructions.md

This ensures the AI technical documentation writer receives comprehensive style guidance including bloat avoidance best practices when processing documentation. The workflow imports directly from the instructions file without needing an intermediate shared file.

Verification

  • ✅ All unit tests pass
  • ✅ technical-doc-writer workflow compiles successfully
  • ✅ The compiled technical-doc-writer.lock.yml includes all imported documentation guidance
  • ✅ Verified the documentation bloat content, examples, and quality guidelines are present in the compiled workflow

The technical documentation writer workflow now has access to the same concise writing guidelines used by the unbloat-docs workflow, ensuring consistency across documentation-related agentic workflows.

Original prompt
  • merge documentation unbloat instructions "style prompt" from unbloat-docs into documentation.insteuctions.md
  • make sure technicial documentation writer agentic workflow imports documentation.instructions.md

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…l-doc-writer

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Merge documentation unbloat instructions into documentation.instructions.md Merge documentation unbloat style guidance and add import to technical-doc-writer workflow Oct 22, 2025
Copilot AI requested a review from pelikhan October 22, 2025 10:04
@@ -0,0 +1,153 @@
### Documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the shared/documentation.md file in commit 619028e.

- github

imports:
- shared/documentation.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot documentation.instructions.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated import to reference ../instructions/documentation.instructions.md directly in commit 619028e.

…file directly

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review October 22, 2025 12:12
@pelikhan pelikhan merged commit 01173fc into main Oct 22, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/merge-unbloat-docs-instructions branch October 22, 2025 12:12
Copilot AI requested a review from pelikhan October 22, 2025 12:12
@github-actions
Copy link
Contributor

Agentic Changeset Generator triggered by this pull request.

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.

2 participants