feat: add README standardization tool #33
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
ProjectAJ14
force-pushed
the
claude/standardize-readme-files-015YFDYiEG8kTjcQnRQes2vw
branch
from
f6c1f54 to
8a90185
Compare
Implements automated system to synchronize common readme sections across all packages while preserving package-specific content. Features: - Centralized section templates in YAML configuration - HTML comment markers to identify managed sections - Variable substitution for package-specific values - Safe operations with dry-run, validation, and automatic backups - Melos integration with melos sync:readme command Structure: - tools/readme_sync/readme_sync.dart - Main sync script - tools/readme_sync/templates/sections.yaml - Section templates - tools/readme_sync/config/packages.yaml - Package configurations - tools/readme_sync/README.md - Comprehensive documentation - tools/readme_sync/EXAMPLE_README.md - Marker placement example Benefits: - Standardizes ~35-40% of readme content across 9 packages - Update once, apply everywhere - Package-specific content never modified - 100% consistency for managed sections Updated: - CLAUDE.md - Added readme sync tool documentation - melos.yaml - Added sync:readme command
Add HTML comment markers to standardized sections across all 9 package readme files, enabling the readme sync tool to manage common content while preserving package-specific documentation. Changes: - Added markers to 9 readme files (8 packages + 1 plugin) - Marked 9 standardized sections per package: - nonstop-header: NonStop branding and logo - badges: Build status and license badges - getting-started: Installation instructions - import-package: Import statements - contributing: Contribution guidelines - connect: Social media links - star-footer: GitHub star CTA - license: MIT license information - founded-by: Founder attribution Updated packages: - connectivity_wrapper - dzod - timer_button - ns_intl_phone_input - html_rich_text - morse_tap - ns_utils - ns_firebase_utils - contact_permission (plugin) All package-specific content (features, usage examples, screenshots, etc.) preserved outside markers and remains unmanaged. The readme files are now ready for synchronization via the command: melos sync:readme
ProjectAJ14
force-pushed
the
claude/standardize-readme-files-015YFDYiEG8kTjcQnRQes2vw
branch
from
8a90185 to
57616b3
Compare
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.
Implements automated system to synchronize common README sections across all packages while preserving package-specific content.
Features:
melos sync:readmecommandStructure:
Benefits:
Updated: