Skip to content

docs: map package features and integration relationships - #339

Merged
lloydrichards merged 5 commits into
mainfrom
package-feature-map
Nov 16, 2026
Merged

lloydrichards merged 5 commits into
mainfrom
package-feature-map

Conversation

@lloydrichards

Copy link
Copy Markdown
Owner

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.

@vercel

vercel Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
effect-vfs-docs Ready Ready Preview Nov 16, 2026 9:26pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 02a501d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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.

Pullfrog  | View workflow run | Using gpt-6.1-sol | 𝕏

@lloydrichards
lloydrichards merged commit c6ca1ee into main Nov 16, 2026
10 checks passed
@lloydrichards
lloydrichards deleted the package-feature-map branch November 16, 2026 21:29

This branch was successfully deployed

1 active deployment
Preview — 02a501de Deployed Nov 16, 2026 by vercel[bot]
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