docs: reorganize newcomer documentation - #439
Conversation
052f8c6 to
0db8705
Compare
0db8705 to
ca5f105
Compare
|
@milindsrivastava1997 Clarifying the Post-ASAP node lists, and correcting an omission in this documentation reorganization: The old My initial rewrite compressed merge/join/subtract/delete into a generic sentence. Although the developer reference still listed them, that made the conceptual page incomplete as a node catalog. Fixed in 7f061e2: the conceptual page now explicitly lists all 11 current variants and their semantics, including Why no separate Those names occur in the earlier design sketch, but are not variants of the current SummaryExpr enum. The summary-maintenance lifecycle layer separately models when that state is created, retained, shared, updated, and retired. It considers ephemeral, prepared, shared, and continuously maintained lifecycles; direct build versus incremental maintenance is another deployment choice, subject to capabilities and evidence. Downstream physical binding/runtime implements the actual build and update operations. Creation and insertion/update behavior therefore still exists through the summary aggregate and its maintenance/physical realization. This is not a one-to-one rename of Update after the documentation-structure review (5e81b67): The final version preserves the original documents and chapter order instead of splitting them. The Post-ASAP document now uses the original list-based structure, contains all 11 current variants, and retains the create/insert explanation above. The separately added developer node-reference file has been withdrawn; the earlier links in this comment describe the intermediate revision, not the final organization. |
|
@milindsrivastava1997 I updated some status after comparing the doc with the code, and kept your reorganization structure. So I will merge it. |
Why
Readers need clear documentation locations and descriptions that match the implemented Planner. The documentation should retain its original explanations, chapter order, diagrams and examples while correcting stale information.
What changed
The subsequent document-splitting approach has been withdrawn. The final changes retain existing document structure and update facts, examples and links where needed. Rebased onto main at 04e5a4e. Rust changes only update documentation/schema paths; planner behavior is unchanged.
Before this PR
Documentation locations mixed audiences, and several references described older node/strategy contracts or overstated implementation limitations. The original chapter structures and examples still contained useful context.
After this PR
Readers can follow audience-specific navigation while retaining the original chapters, diagrams and examples. The existing sections explain current candidate forms, accuracy certification and selection boundaries; the Post-ASAP node list is complete and agrees with the code.
Validation