Skip to content

docs: augment PROJECT_STRUCTURE.md with libs/ vs src/ boundary#1093

Merged
kcenon merged 1 commit into
developfrom
docs/issue-1089-augment-project-structure
May 1, 2026
Merged

docs: augment PROJECT_STRUCTURE.md with libs/ vs src/ boundary#1093
kcenon merged 1 commit into
developfrom
docs/issue-1089-augment-project-structure

Conversation

@kcenon

@kcenon kcenon commented May 1, 2026

Copy link
Copy Markdown
Owner

Closes #1089

Summary

  • Document libs/network-*/ vs src/ responsibilities (umbrella target vs modular ABI-stable libraries)
  • Resolve src/protocol/ vs src/protocols/ ambiguity:
    • src/protocol/ (singular): thin protocol entry-point factories (connect, listen, create_connection, create_listener)
    • src/protocols/ (plural): heavy wire-level implementations (frame parsers, state machines, codecs)
    • Both are current as of 2026-05; neither is legacy; renaming is out of scope
  • Add 'Decision Tree: Where Does New Code Go?' section with 8 branches and 3 worked examples
  • Mirror all new sections into docs/PROJECT_STRUCTURE.kr.md (Korean)

Test Plan

  • README.md line 698 link to docs/PROJECT_STRUCTURE.md still resolves (path unchanged)
  • Section anchors verified for both English and Korean documents
  • No code changes; CI matrix should pass trivially

Part of #1083.

Document the boundary between libs/network-*/ modular protocol
libraries and the src/ source tree, and resolve the ambiguity
between src/protocol/ (singular, factory entry points) and
src/protocols/ (plural, full protocol implementations).

Add a 'Decision tree: where does new code go?' section with
worked examples covering new protocols, internal helpers, and
public headers.

Mirror updates into docs/PROJECT_STRUCTURE.kr.md.

Closes #1089
@github-actions

github-actions Bot commented May 1, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

Metric Value
Line Coverage 69.2%
Branch Coverage 34.5%
Target 80% lines / 70% branches
Coverage Details

Full HTML report is available as a build artifact.

@kcenon kcenon merged commit 33313ae into develop May 1, 2026
9 checks passed
@kcenon kcenon deleted the docs/issue-1089-augment-project-structure branch May 1, 2026 23:15
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