docs: fix example count exaggeration across documentation#100
Merged
Conversation
The example/ directory contains 27 YAML config files, not 100+. Updated all references across README.md, CONTRIBUTING.md, docs/tutorials/getting-started.md, and docs/adr/001-yaml-driven-config.md. Closes #70 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation to remove the exaggerated “100+ example configs” claims and replace them with a specific example count intended to match what’s in example/.
Changes:
- Replaced “100+” example count references with “27” across multiple docs.
- Renamed the README section header to remove the “100+” phrasing.
- Updated
example/directory descriptions in project-structure listings.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/tutorials/getting-started.md | Updates the stated count of example YAML configs. |
| docs/adr/001-yaml-driven-config.md | Updates the ADR consequence text to reference the new example count. |
| README.md | Removes “100+” wording and updates example count references in narrative + project tree. |
| CONTRIBUTING.md | Updates the project tree’s example/ line to the new count. |
Contributor
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Contributor
* Initial plan * docs: clarify example counts per review suggestions Co-authored-by: intel352 <77607+intel352@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
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.
Summary
example/directoryCloses #70
Test plan
example/directory