docs: reconcile AGENTS.md with GA scope#55
Merged
Conversation
Bring the three top-level docs in line with the GA Readiness Handoff (issue #22) so they reflect management-plane stability rather than Phase 9 enterprise-feature work. AGENTS.md: - pkg/cmd/ tree now matches actual directories (drops auth, token, user, role, permission-policy, custom-plugin, portal, audit-log, route-template, service-registry, secret-provider). - pkg/api/ types_*.go list matches the files on disk (drops the fictional types_token.go, adds the rest). - Document Map adds skills.md, documentation-maintenance.md, ga-test-plan.md, ga-test-report.md, and user-guide/. - API7 EE vs APISIX section reframes "enterprise resources" as out-of-scope for GA and points at the deferred sections. - Commit-scope example drops the unimplemented "token" scope. PRD.md: - Goals section narrows to GA-supported runtime resources plus gateway-group; session login marked deferred. - Control-plane Tokens / Users & RBAC / Developer Portal / Custom Plugins / System sections collapsed into a single "deferred (post-GA)" note; Service Templates flagged as not supported in GA. - Phase 9 renamed to top-level "Deferred (Post-GA)" with an explicit note that these are not GA commitments. - Feature parity table replaces "Phase 9" labels with "Deferred (post-GA)". docs/roadmap.md: - Drop the stale "Phase 5 IN PROGRESS" header. - Replace the pre-completion PR breakdown with a phase-status table (Phases 1 through 8 marked complete) and a GA Readiness Handoff section that links #22 and the GA test plan/report. - Move Phase 9 content into a "Deferred (Post-GA)" table. Closes #28.
📝 WalkthroughWalkthroughThree documentation files are updated to align GA scope and deferral strategy: PRD.md redefines goals and command surface for management-plane stability, AGENTS.md updates architecture/structure documentation, and docs/roadmap.md transitions to a GA-centric phase completion and readiness model with explicit post-GA deferrals. ChangesGA Scope Documentation Alignment
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Drop PRD.md from the GA-scope reconciliation. AGENTS.md and docs/roadmap.md changes remain.
Drop docs/roadmap.md from the reconciliation. Only AGENTS.md remains in this PR.
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
Bring
AGENTS.mdin line with the GA Readiness Handoff (#22) so the development guide reflects the code as it actually is.pkg/cmd/tree now matches the actual directories on disk (dropsauth,token,user,role,permission-policy,custom-plugin,portal,audit-log,route-template,service-registry,secret-provider).pkg/api/types list matches the files on disk (drops the fictionaltypes_token.go, addstypes_consumer_group.go,types_credential.go,types_plugin.go,types_plugin_metadata.go,types_global_rule.go,types_stream_route.go,types_secret.go,types_proto.go,types_config.go, pluspkg/listutil/andpkg/selector/).skills.md,documentation-maintenance.md,ga-test-plan.md,ga-test-report.md, anduser-guide/.PRD.md/docs/roadmap.md.tokenscope and lists the actually-shipped scopes.PRD.md and docs/roadmap.md changes that were on this branch earlier were reverted at the author's request; this PR is AGENTS.md only.
Refs #28. Part of #22.
Test plan
pkg/cmd/<dir>andpkg/api/types_*.goreferenced in AGENTS.md exists on disk.docs/*.mdreferenced in the Document Map exists.