Skip to content

[docs] Remove bloat from SampleWebApi README#15

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/unbloat-samplewebapi-readme-34dc3506e9ac031b
Draft

[docs] Remove bloat from SampleWebApi README#15
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/unbloat-samplewebapi-readme-34dc3506e9ac031b

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Cleaned up samples/SampleWebApi/README.md to remove unnecessary labels and convert a bullet list to prose.

File improved: samples/SampleWebApi/README.md

Changes made:

  • Removed Then call the API: label — the curl code block is self-explanatory immediately after the dotnet run block
  • Converted the Docker Compose startup bullet list (4 lines) to a single inline prose sentence
  • Removed After startup, request: label — unnecessary intro before the curl example

Reduction: 42 → 35 lines (~17% line reduction, ~26% word count reduction)

All essential information — commands, ports, URLs, and instructions — is fully preserved.

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Jul 13, 2026, 2:09 PM UTC

- Remove 'Then call the API:' label (self-evident from context)
- Convert Docker Compose startup bullet list to inline prose
- Remove 'After startup, request:' label (unnecessary intro)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants