docs: consolidate redundant content and fix inconsistencies#322
Open
biglyan wants to merge 5 commits into
Open
docs: consolidate redundant content and fix inconsistencies#322biglyan wants to merge 5 commits into
biglyan wants to merge 5 commits into
Conversation
…ists Remove several outdated or redundant documents that no longer reflect the current state of the project after v1.0.0 and v1.1.0 releases: Deleted: - docs/concepts/agent-first-repo-blueprint.md (superseded by AGENTS.md) - docs/operations/agent-first-operating-reference.md (superseded by AGENTS.md) - docs/release/PRE_V1_RELEASE_CHECKLIST.md (v1 already released) - docs/release/POST_V1_EVIDENCE.md (outdated, content migrated to v1.0.0.md) Updated all references across: - README.md, README_CN.md, AGENTS.md, CLAUDE.md - All module.yaml files (stable roots and x/* extensions) - docs/ hierarchy (concepts, operations, reference, release, start, evidence) - specs/repo.yaml, specs/task-routing.yaml - internal/checks/checkutil/guidance.go - internal/checks/reference-layout/main.go - .github/workflows/quality-gates.yml - reference/standard-service/README.md - cmd/plumego/README.md Regenerated website/src/generated/roadmap.ts via make website-sync. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove duplicated content that overlaps with authoritative sources: - core-boundary.md: remove wiring patterns section (canonical-style-guide.md §4-13 covers this) - extension-boundary.md: remove maturity ladder and promotion criteria (extension-stability-policy.md is authoritative) - milestone-pipeline.md: remove minimal templates section (93 lines duplicating TEMPLATE.md files) - canonical-style-guide.md: consolidate §14-16 into single §14 pointing to AGENTS.md - adoption-path.md: fix duplicate AGENTS.md reference in "1 Day" reading list Fix inaccuracies: - extension-authoring.md: correct module_path example to use external module path Net reduction: ~300 lines of redundant documentation.
Bumps the npm_and_yarn group with 1 update in the /use-cases/guardus/web/app directory: [react-router](https://github.com/remix-run/react-router/tree/HEAD/packages/react-router). Updates `react-router` from 6.30.3 to 6.30.4 - [Release notes](https://github.com/remix-run/react-router/releases) - [Changelog](https://github.com/remix-run/react-router/blob/react-router@6.30.4/packages/react-router/CHANGELOG.md) - [Commits](https://github.com/remix-run/react-router/commits/react-router@6.30.4/packages/react-router) --- updated-dependencies: - dependency-name: react-router dependency-version: 6.30.4 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <support@github.com>
- Fix path parameter syntax in getting-started_CN.md: use :id instead of {id}
- Fix non-existent app.Start(ctx) references in migration guides (from-gin, from-echo, from-chi)
- Update why-plumego.md to show correct lifecycle wiring (Prepare/Server/ListenAndServe)
- Clarify path parameter syntax in troubleshooting.md: confirm :param notation
All gates pass. Stable-module coverage: 96.4%.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.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
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.
Summary
Consolidate and deduplicate documentation across the Plumego codebase to improve maintainability and reduce redundancy.
Changes
Content consolidation (~300 lines removed):
docs/concepts/core-boundary.md: Remove wiring patterns section (covered by canonical-style-guide.md §4-13)docs/concepts/extension-boundary.md: Remove maturity ladder and promotion criteria (extension-stability-policy.md is authoritative)docs/operations/milestone-pipeline.md: Remove minimal templates section (93 lines duplicating TEMPLATE.md files)docs/reference/canonical-style-guide.md: Consolidate §14-16 into single §14 with cross-references to AGENTS.mdBug fixes:
docs/start/adoption-path.md: Fix duplicate AGENTS.md reference in "1 Day" reading listdocs/guides/extension-authoring.md: Correct module_path example to use external module path instead of internal plumego pathImpact
Test plan
make website-syncto regenerate docs site🤖 Generated with Claude Code