Skip to content

docs: expand API and interface design content - #12

Merged
DevMPoveaCL merged 8 commits into
mainfrom
feat/expand-api-design-content
May 13, 2026
Merged

DevMPoveaCL merged 8 commits into
mainfrom
feat/expand-api-design-content

Conversation

@DevMPoveaCL

Copy link
Copy Markdown
Owner

Summary

  • Aggregates the reviewed API/interface design chain into the main playbook flow.
  • Adds a canonical API topic covering REST, SOAP, gRPC, WebSocket, Webhooks, GraphQL, and WebRTC.
  • Clarifies boundaries in related topics and integrates navigation between Networking and SQL.

Chain Context

main
└─ 📍 final tracker: feat/expand-api-design-content
   ├─ PR #9: API topic content
   ├─ PR #10: boundary cleanup
   └─ PR #11: navigation + lint verification

Changes

Area Change
API_AND_INTERFACE_DESIGN/ New 3-level canonical topic for API/interface design.
Related docs Networking, System Design, React+SpringBoot, and JS now point API design decisions to the canonical topic.
Navigation Root README, Networking, and SQL place API topic between Networking and SQL.
.markdownlint.json Captures didactic Markdown lint conventions used by this repo.

Testing

  • npx --yes markdownlint-cli API_AND_INTERFACE_DESIGN/**/*.md
  • Changed-file markdownlint check passed during SDD verify.
  • git diff --check HEAD~1..HEAD
  • SDD verify final verdict: PASS WITH WARNINGS.

Known Warnings

  • Repo-wide markdownlint has unrelated baseline failures.
  • lychee did not resolve via npx during verification.

Acceptance Checklist

Closes #8

@DevMPoveaCL DevMPoveaCL added the type:docs Documentation-only change label May 13, 2026
@DevMPoveaCL
DevMPoveaCL merged commit 9970717 into main May 13, 2026
1 check passed
@DevMPoveaCL
DevMPoveaCL deleted the feat/expand-api-design-content branch May 15, 2026 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation-only change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add API and interface design playbook topic

1 participant