Repository navigation
docs: map package features and integration relationships - #339
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes across the README and OKF package documentation, checking capability and integration claims against package documentation and contracts.
- Package overview: Adds matching Mermaid diagrams connecting the preview engine, community packages, and consumers.
- Feature map: Documents core workflows, adapter capabilities, synchronous Node requirements, and qualified NFS durability.
- Knowledge integration: Updates architecture navigation, dependency ownership, and the knowledge log. OKF validation and evaluation passed with no findings, broken links, or isolated concepts; visual rendering was not verified.
gpt-6.1-sol | 𝕏

Goal/Scope
Make the relationship between the Effect preview, core, and community filesystem packages visible to readers choosing an integration.
Description
Add a compact package overview to the root README and a detailed vertical feature map to OKF. Labeled arrows describe capability flows. Package colors and distinct shapes identify Effect capabilities, community features, external consumers, and requirements.
Document synchronous memory requirements for Node and qualified durability requirements for writable NFS. Update the architecture index, package dependency model, and knowledge log to connect the map to its supporting contracts.
Comment
Builds on the diagram in Effect-TS/effect#9960. Visual rendering has not been verified.