Skip to content

Commit 581d52b

Browse files
committed
Reorganize proposal with Overview section and better flow
Restructure the document to improve readability and follow logical progression from high-level to detailed design: Changes: - Add 'Overview' section with high-level description and architecture flow - Move architecture flow diagram from buried section to Overview (first thing readers see) - Rename 'API Design' subsections for clarity: - 'Architecture Components' → 'Component Overview' - Group detailed flows under 'Implementation Details' - Add forward reference link to API Specification - Remove duplicate High-Level Architecture diagram - Promote 'Architecture and Components' to top-level subsection - Promote 'Implementation Details' to top-level subsection New flow: User Stories → Overview (what/why) → API Design (examples) → Architecture (components) → Implementation (how) → Security → Risks This matches the recommendation: show WHAT before HOW, with progressive detail from overview to implementation specifics. Signed-off-by: zhujian <jiazhu@redhat.com>
1 parent 89948df commit 581d52b

1 file changed

Lines changed: 121 additions & 105 deletions

File tree

  • enhancements/sig-architecture/233-subject-mapping

0 commit comments

Comments
 (0)