docs: fix stale code/doc inconsistencies + 2 script bugs - #11
Merged
Conversation
…x 2 script bugs Doc-vs-code audit follow-up. Corrections: API docs (docs/ + docs/zh-CN/): - API_CONFIGURATION: re-point the tenant-business-interface section away from the non-existent server/tenant-template.yaml to the real split files (services/tenant-api/template.yaml + services/order-service/template.yaml); fix GetOrdersFunction CodeUri (OrderService/ -> src/), the cross-stack ARN wiring (!Ref GetOrdersFunctionArn), the ReservedConcurrentExecutions expr, and CreateTenantAdminUser CodeUri (../TenantManagementService/ -> ../tenant-management/). Snippets now match the templates verbatim. - THROTTLING_AND_MONITORING: fix the metric-filter file/line reference. Frontend docs/code: - Admin README + modules.md: Angular 14 -> 20, drop Flex Layout, v4 Auth snippets -> v6 fetchAuthSession, fix component names, drop broken screenshot links. - Application/Landing README: Angular CLI 14.0.5 -> 20.x; e2e text -> Playwright. - cypress/README: mark Cypress legacy, point to canonical Playwright e2e/, fix stale repo path. - Landing register.component.html: remove dead fxLayout directive (flex-layout was removed). Scripts (code bugs): - generate-env-config.js: query a non-existent API GW name -> read AdminApi output from saas-control-stack (mirrors get-login-info.js). - DEPLOYMENT_GUIDE.md: rewrite the fictional multi-env guide to the real ./deployment.sh + ./geturl.sh flow. Governance: - CONTRIBUTING: document main branch protection (PR required, CI gating). - SECURITY + CHANGELOG: reconcile to "no tagged releases" (tag was deleted); remove broken compare/tag links. - CHANGELOG: "per-service tests" -> product/order only; add Unreleased entry. - README.zh-CN: fix deep-dive link text to match zh-CN targets. - PR template: use repo-relative CONTRIBUTING.md link. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Follow-up to a doc-vs-code audit. Fixes verified inconsistencies (each checked against the actual code/templates) plus two real script bugs.
Backend docs (docs/ + docs/zh-CN/)
server/tenant-template.yaml(no longer exists). Re-pointed to the real split files, fixedCodeUri(OrderService/→src/), cross-stack ARN wiring (!Ref GetOrdersFunctionArn),ReservedConcurrentExecutions, andCreateTenantAdminUserCodeUri. Snippets now match templates verbatim.Frontend docs/code
Auth.currentSession()snippets → v6fetchAuthSession(), fixed component names, dropped broken screenshot links.ng e2e→ Playwright.cypress/README.md: marked legacy, pointed to canonical Playwrighte2e/, fixed stale repo path.Landing/.../register.component.html: removed deadfxLayoutdirective.Script bugs (functional)
generate-env-config.js: was querying a non-existent API Gateway name (always failed) → now reads theAdminApioutput fromsaas-control-stack, mirroringget-login-info.js.DEPLOYMENT_GUIDE.md: replaced a fictional multi-env tutorial (deploy-all.sh,--config-env prod/dev/stage, suffixed stacks — none exist) with the real./deployment.sh+./geturl.shflow.Governance
mainbranch protection (PR required, CI gating).[Unreleased]entry for branch protection + full-CI-on-PR.docs/zh-CN/...targets.CONTRIBUTING.mdlink.🤖 Generated with Claude Code