[docs] Consolidate developer specifications - Remove marketing language #12898
Conversation
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
Replace subjective marketing terms with precise technical language across 20 documentation files: - "comprehensive" → specific, measurable terms (13 instances) - "simple" → technical definitions (9 instances) - "clearly" → objective descriptions (5 instances) - Other subjective terms → technical specifications (2 instances) This improves technical clarity and maintains professional documentation standards. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
This was referenced Jan 31, 2026
pelikhan
approved these changes
Jan 31, 2026
This was referenced Jan 31, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Developer Documentation Consolidation
This PR consolidates markdown specifications from the
scratchpad/directory by removing marketing language and replacing it with precise technical terminology.Changes Made
29 tone adjustments across 20 files:
Marketing Language Removed
"comprehensive" (13 instances) → Replaced with specific, measurable terms
comprehensive development environment→development environment with 200+ pre-installed toolscomprehensive tests→tests covering all parsing scenarioscomprehensive logging→structured audit logging"simple" (9 instances) → Replaced with technical definitions
simple-issue-responder→basic-issue-respondersimple automation→single-step automationsimple Go types→built-in Go types with direct JSON Schema mappings"clearly" (5 instances) → Replaced with objective descriptions
Explain validation failures clearly→with specific error codes and contextMark status clearly→Mark status with standard iconsOther subjective terms (2 instances) → Replaced with technical specifications
very large→exceed GitHub's API limitsrobust system→multi-agent orchestration system with persistent state managementFiles Modified
High-Impact Files:
scratchpad/mdflow.md- 6 changesscratchpad/oh-my-code.md- 4 changesscratchpad/mods/jsonschema-go.md- 3 changesOther Files: 17 additional files with 1-2 changes each
Consolidated File:
.github/agents/developer.instructions.md- Updated date and removed marketing languageValidation
✅ All markdown validated
✅ Frontmatter present and valid
✅ 10 Mermaid diagrams intact
✅ 40 code blocks with language tags
✅ Consistent technical tone
✅ All 37 spec references maintained
Impact
Review Notes
Please review:
See the discussion for detailed consolidation report with complete change log and historical comparison.
References: