docs: Community-friendly documentation and governance pass#359
Draft
biglyan wants to merge 1 commit into
Draft
Conversation
Add comprehensive documentation and governance files to position Plumego as a standard-library-first Go HTTP toolkit for explicit, maintainable, agent-friendly services: 1. STABILITY.md: Full compatibility policy and maturity levels - Stable root packages (GA guarantees) - Extension maturity levels (experimental, beta, GA) - SemVer expectations and breaking change policy - Go version support policy 2. COMPATIBILITY.md: How Plumego integrates with stdlib and ecosystem - Standard library compatibility patterns - Middleware and logger neutrality - Storage and config flexibility - Migration and exit strategies - Quick compatibility checklist 3. docs/EXTENSION_MATURITY.md: Human-readable maturity dashboard - Quick reference table for maturity levels - Characteristics and use cases for each level - Current packages by maturity - Migration paths between levels - How to check package maturity 4. docs/roadmap/go-community-friendly-iteration-plan.md: Strategic iteration plan - Community value assessment - Market positioning and differentiators - Three-phase roadmap (v1.2, v1.3, v2.0) - Risk mitigation strategies - Success criteria and verification matrix - Adoption path (5-minute, 30-minute, 1-day, production) 5. examples/: Minimal, runnable examples - hello/: Basic app, routing, and logging - json-api/: CRUD operations, JSON, error handling - Both examples compile with stable roots only No runtime changes. No public API changes. https://claude.ai/code/session_01VZpgZEuFRt7h8uz8eNviHm
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
This PR implements the first documentation and governance pass to make Plumego more friendly to the Go developer community.
Scope: Documentation, examples, and governance files only. No runtime behavior changes. No public API changes.
Changes
1. STABILITY.md (269 lines)
2. COMPATIBILITY.md (431 lines)
3. docs/EXTENSION_MATURITY.md (229 lines)
4. docs/roadmap/go-community-friendly-iteration-plan.md (381 lines)
5. examples/ (2 working examples)
hello/: Minimal "hello world" service
json-api/: REST-like JSON API with CRUD operations
6. examples/README.md (60 lines)
Positioning
This documentation pass positions Plumego as:
Key differentiators:
http.Handler, not framework-specificfunc(http.Handler) http.HandlersignatureVerification
✅ All tests pass:
go test ./...✅ No vet warnings:
go vet ./...✅ Examples compile:
examples/hellobuilds successfullyexamples/json-apibuilds successfully✅ No runtime changes
✅ No public API changes
✅ No refactoring of packages
Files Changed
STABILITY.md(new)COMPATIBILITY.md(new)docs/EXTENSION_MATURITY.md(new)docs/roadmap/go-community-friendly-iteration-plan.md(new)examples/README.md(new)examples/hello/main.go(new)examples/hello/go.mod(new)examples/hello/README.md(new)examples/json-api/main.go(new)examples/json-api/go.mod(new)examples/json-api/README.md(new)Follow-up Recommendations
Test Plan
Generated by Claude Code