Skip to content

docs: reconcile AGENTS.md with GA scope#55

Merged
shreemaan-abhishek merged 3 commits into
masterfrom
docs/reconcile-ga-scope-28
May 27, 2026
Merged

docs: reconcile AGENTS.md with GA scope#55
shreemaan-abhishek merged 3 commits into
masterfrom
docs/reconcile-ga-scope-28

Conversation

@shreemaan-abhishek
Copy link
Copy Markdown
Contributor

@shreemaan-abhishek shreemaan-abhishek commented May 27, 2026

Summary

Bring AGENTS.md in 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 (drops auth, 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 fictional types_token.go, adds types_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, plus pkg/listutil/ and pkg/selector/).
  • Document Map adds skills.md, documentation-maintenance.md, ga-test-plan.md, ga-test-report.md, and user-guide/.
  • "API7 EE vs APISIX Differences" reframes enterprise modules (RBAC, portal, audit logs, custom plugins, service registries, access-token management) as out of scope for GA and points at the deferred sections in PRD.md / docs/roadmap.md.
  • Commit-scope example drops the unimplemented token scope 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

  • Confirm every pkg/cmd/<dir> and pkg/api/types_*.go referenced in AGENTS.md exists on disk.
  • Confirm every docs/*.md referenced in the Document Map exists.
  • CI green on the branch.

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.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

📝 Walkthrough

Walkthrough

Three 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.

Changes

GA Scope Documentation Alignment

Layer / File(s) Summary
GA Scope Definition and Command Surface
PRD.md
Design philosophy anchors to "management-plane stability" GA with deferred enterprise modules. Goals rewritten into GA-scoped checklist mandating access-token authentication, gateway-group control, and file-based CRUD/declarative operations. a7ee access tokens marked GA-supported; session login deferred. Command surface updated: gateway-group commands added, service templates marked "Not supported in GA," control-plane modules (tokens, RBAC, portal, custom plugins, system, audit logs) moved to deferred section. Feature parity table marks bulk operations, interactive mode, and extension system as post-GA.
Architecture Documentation Refresh
AGENTS.md
Document Map and Project Structure tables rewritten to reflect current command/module layout. API7 EE vs APISIX Differences section emphasizes gateway-group scoping, token/prefix conventions, JSON Patch behavior, and GA scope boundaries. Resources NOT Exposed section clarified to exclude deferred enterprise modules. Commit message scope examples expanded.
Roadmap Phase Completion and GA Readiness
docs/roadmap.md
Introduction replaced: Phases 1–8 declared complete; Phase 9 deferred post-GA with management-plane focus. Completed Phases table finalized with pointer to PRD goals checklist. Remaining PR summary replaced by GA Readiness Handoff section (issue #22 anchor) enumerating detailed exit criteria and test plan references. Phase 9 Enterprise Features section replaced by Deferred (Post-GA) section listing token management, RBAC, developer portal, custom plugins, audit logs, system settings, session login, interactive mode, extension/plugin system, and bulk operations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • api7/a7#40: Both PRs update GA/scoping docs around "resources not exposed in API7 EE"—the main PR refreshes that documentation coverage (AGENTS/PRD/roadmap) while PR #40 removes the corresponding not-exposed resource stubs from docs/api7ee-api-spec.md.
🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Linked Issues check ✅ Passed All objectives from issue #28 are met: PRD.md, docs/roadmap.md, and AGENTS.md are reconciled with GA scope; Phase 9 enterprise content is deferred; and non-existent pkg/cmd/ directories are removed.
Out of Scope Changes check ✅ Passed All changes are documentation-only updates directly tied to GA scope reconciliation; no code changes or unrelated edits are present.
E2e Test Quality Review ✅ Passed PR addresses issue #28: AGENTS.md lists only existing pkg/cmd/ dirs, PRD.md adds "Deferred (Post-GA)", roadmap.md removes stale "Phase 5". Documentation changes verified against actual repo state.
Security Check ✅ Passed Documentation-only PR with no code changes. No credentials leaked, no secrets exposed, no auth bypasses. Example tokens use placeholders (a7ee.xxxxxxxxxx/yyyyyyyyyy).
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: reconcile AGENTS.md with GA scope' directly reflects the main changeset, which reconciles three documentation files (AGENTS.md, PRD.md, and docs/roadmap.md) with GA scope.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/reconcile-ga-scope-28

Comment @coderabbitai help to get the list of available commands and usage tips.

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.
@shreemaan-abhishek shreemaan-abhishek changed the title docs: reconcile PRD, roadmap, and AGENTS with GA scope docs: reconcile AGENTS.md with GA scope May 27, 2026
@shreemaan-abhishek shreemaan-abhishek merged commit e97dda6 into master May 27, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant