Documentation cleanup and v2.0 production release #18
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
This design addresses documentation debt from v2.0 development by: - Removing historical artifacts and research documents - Reorganizing into user-facing, historical, and maintenance tiers - Rewriting README to lead with production-ready v2.0 - Converting TODO.md to ROADMAP.md celebrating v2.0 completion - Adding v2.0.0 CHANGELOG entry
Major documentation overhaul to reflect v2.0 completion: **Cleanup:** - Removed research artifacts (GLOBALS_LOGGING_RESEARCH.md, LOGGING_ANALYSIS_BY_FILE.md) - Gitignored historical docs (docs/plans/, docs/internal/) - Archived completed design documents **Restructure:** - Renamed TODO.md → ROADMAP.md - Celebrates v2.0 completion with clear future vision **Content Updates:** - README.md: Complete rewrite leading with production-ready v2.0 - Real-world examples first (user events, app logs) - Maritime positioned as optional test data - Comprehensive troubleshooting and operations sections - CHANGELOG.md: Added v2.0.0 release entry - ROADMAP.md: Highlights completed features, clear v3.0 vision - CONTRIBUTING.md: Updated testing section, current architecture **Impact:** New developers with existing BigQuery data can now: - Immediately see production-ready status - Find their use case in Quick Start (not maritime) - Understand what works today vs. what's planned - Access maritime example when needed for testing All tests pass (91/91). All documentation links verified.
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
Major documentation overhaul to reflect v2.0 completion and make the project easier for new developers to find, understand, and use.
Target Audience: Developers with existing BigQuery data who want to sync to Harper (not maritime-focused users)
Changes
Cleanup
Restructure
Content Updates
README.md - Complete rewrite (517 lines)
CHANGELOG.md
ROADMAP.md
CONTRIBUTING.md
Impact
New developers with existing BigQuery data can now:
Verification
Test Plan