docs: update README files to reflect current codebase architecture - #1620
Merged
Merged
Conversation
- Main README: add extensions table, project structure, skills/sandbox/ integrations/tasks features - src/README: add 15+ new modules (skill, chat, discovery, sandbox, jobs, task, channels, integrations, internal-agents, schemas, registry, fs, markdown, mdx, extensions bridge), update dependency layers - CLI README: expand commands table (25+ commands), add skills directory - Architecture README: add extension system, AG-UI protocol, multi-tenant isolation sections and cross-references - React README: add chat components (Chat, AgentCard, Message, Markdown, ModelSelector, ChatWithSidebar), primitives directory - Security README: add CSRF, path-validation, sandbox, secure-fs, deno permissions to architecture - Server README: add service server and node handler exports
- 06-discovery-extensions: update contract diagram from 12 to 14 domains, rename AIModelProvider → LLMProviderRegistry + LLMProvider:*, add ModuleLexer and TokenCacheStore, list all first-party extension packages - 08-support-matrix: add extension contracts, workflow engine, discovery, cloud agent service, and control-plane to capability boundaries; add full extension contract matrix with package names and runtime requirements - guides/extensions: rename all old package references to current names (ext-jwt → ext-auth-jwt, ext-redis → ext-cache-redis, ext-esbuild → ext-bundler-esbuild, etc.), update contract table with correct package names and add ModuleLexer/LLMProvider:* entries, fix AIProviderRegistry → LLMProviderRegistry in code examples
…extension - Create extensions/README.md with catalog grouped by type (AI/LLM, Security, Build Pipeline, Content, Infrastructure), architecture diagram, and package structure documentation - Add extension type and contract metadata line to all 12 extension READMEs (e.g. "Type: LLM Provider | Contract: LLMProvider:anthropic") - Fix stale AIProviderRegistry → LLMProviderRegistry and AIProviderConfig → LLMProviderConfig in ext-llm-anthropic, ext-llm-google, and ext-llm-openai READMEs
…h provides All 12 extension READMEs now consistently open with "Provides X for Veryfront" instead of "Veryfront extension that registers the Y contract".
- Remove broken links to non-existent skills.md and tasks.md guides - Add ext-zod (SchemaValidator) to main README extensions table - Fix project structure tree indentation alignment - Separate ext-zod into its own Validation category in extensions/README.md
ariskemper
marked this pull request as ready for review
May 13, 2026 07:51
9 built-in (auto-loaded at bootstrap): ext-zod, ext-bundler-esbuild, ext-parser-babel, ext-transform-mdx, ext-css-tailwind, ext-node-compatibility, ext-llm-openai, ext-llm-anthropic, ext-llm-google 3 optional (user-installed): ext-auth-jwt, ext-cache-redis, ext-tracing-opentelemetry - Add Required column to extensions/README.md catalog tables - Add Built-in/Optional badge to each extension's metadata line - Add explanatory note about built-in vs optional behavior
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e4a0cf4f4b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- Fix LLM extension contract from LLMProvider:* to LLMProvider (the suffixed form is a capability declaration, not the contract interface) - Fix server README exports to match actual barrel (createVeryfrontServer, startVeryfrontServer, startNodeVeryfrontServer, toNodeHandler) - Fix skill and task export aliases from veryfront/* to #veryfront/* (internal-only, no public export path) - Update architecture docs and guides to use LLMProvider consistently
ariskemper
force-pushed
the
docs/update-readmes-2025
branch
from
May 13, 2026 08:17
1391e54 to
e67c036
Compare
Reduces three classification levels (section, type, contract) to two (category, contract). The Category in each extension README now matches its section heading in the catalog exactly: - AI / LLM, Security, Build Pipeline, Content, Validation, Infrastructure Removes the redundant Type column from catalog tables since the section heading already provides that information.
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan