Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 3.8 KB

File metadata and controls

64 lines (52 loc) · 3.8 KB

Design Documents Index

This directory is the repository-native map for Loong's public architecture references.

The Mintlify site under site/ is the public builder-facing reading path. This index exists for contributors and source readers who need the repository markdown behind that shorter public architecture summary.

Read This Index When

  • you need the repository-native architecture references rather than the shorter Mintlify summary
  • you are changing runtime boundaries, layering, or engineering rules
  • you want the source documents that back the public builder contract

Route By Audience

If you are trying to... Start here Why
read the public builder-facing overview first ../../site/build-on-loong/overview.mdx site/ is the public builder hub
edit repository-native architecture references this index this directory is the source-facing architecture map
understand the overall repository docs layering ../README.md it explains how repo-native docs differ from Mintlify pages

What Stays Here

This directory keeps the architecture references that remain part of the OSS surface. Deeper implementation packages, comparative studies, and internal-only design backlog artifacts are intentionally out of the public docs flow.

Source Design Map

Document Read it when...
Core Beliefs you need the engineering principles that should survive refactors
Layered Kernel Design you need the crate and layer boundary model before changing runtime shape
Runtime Entrypoint and Bootstrap Map you need the shortest source-facing map of how CLI, channel, gateway, control-plane, and daemon task turns enter the shared runtime
Single-Entry Runtime Convergence you are working on session-vs-memory ownership or converging host turn seams without breaking the current crate contract
Harness Engineering you are working on the agent-driven development environment itself
Execution Discipline And Long-Running Ownership you are changing proactive agent behavior, long-running task ownership, or completion semantics beyond one turn
Tool Surface Exposure you are changing provider-visible tool exposure, discovery, or hidden-tool progressive disclosure

Boundary Rules

  • keep this index focused on architecture references that remain part of the OSS source surface
  • do not turn design-docs/ back into a catch-all archive for backlog design bundles, internal comparisons, or implementation packages
  • put new reader-facing explainers in site/ when they are really public docs pages rather than source references

Suggested Reading Order

  1. Start with Core Beliefs if you need the repository's architectural taste and invariants.
  2. Continue to Layered Kernel Design if the change touches boundaries, ownership, or layering.
  3. Read Runtime Entrypoint and Bootstrap Map when the problem is “which runtime/bootstrap surface actually owns this turn?”
  4. Read Execution Discipline And Long-Running Ownership when the work is really about proactive execution, long-running task state, or completion semantics.
  5. Read Tool Surface Exposure when the work touches provider-visible tools, discovery, or hidden-tool progressive disclosure.
  6. Read Harness Engineering only when the work is really about the development environment or agent workflow itself.