Skip to content

INDEX.md

Latest commit

 

History

History
111 lines (87 loc) · 8.74 KB

INDEX.md

File metadata and controls

111 lines (87 loc) · 8.74 KB
Raw

Documentation Index

English | 简体中文

Start with the goal that matches what you are trying to do.

I want to use WebCodex normally

I only want to try it for a few minutes

  • Quick Trial — temporarily try one repository with one webcodex share command

I need production deployment or deep troubleshooting

I need authentication or network options

  • MCP — Bearer, query-token fallback, OAuth, private tunnel, and MCP protocol reference
  • Authentication — detailed credential and authority boundaries
  • Deployment — stable HTTPS origins, self-hosting, and production networking

I need help

  • Troubleshooting — ChatGPT/MCP Host, installation, connection, runtime, and Runner problems
  • Security — safe operating guidance and security model

I want to understand or extend WebCodex

  • Architecture — how the major components fit together
  • Coding Workflow — task bootstrap, guidance, validation, and closeout
  • Native Tool Plugins — add Runner-local tools with any executable language and no MCP SDK
  • Computer Use — current desktop primitives, authority/platform boundaries, and explicitly unimplemented directions
  • Browser/CDP runtime architecture — current Browser ownership, managed sessions, handoff, authority, and stale fencing

Architecture reading path

Read each row's current contract before its implementation or experiment record. For Agent Infra or application design study, ask which component owns identity, authority, state, retries and the next observation; follow the linked source/tests in the contract instead of copying a second normative checklist.

Step and question Read next
1. Where does a request execute, and what survives device replacement? Architecture and request trace, Runner, Server-owned tunnels
2. How do tools become discoverable without widening authority? MCP, tool contracts, Context/guidance, Control sidecars
3. What is evidence, what is execution, and what can resume? Session model, SQLite and Hot/Cold residency, Job recovery, manual collaboration
4. How do Goal, Agent Task/TaskAttempt, Conversation and Wake differ? Durable Agent architecture, current communication contract
5. Why do UI actions need exact targets and fresh observations? Browser/CDP, browser continuity, Computer Use
6. What context and extension resources actually exist? Native Tool Plugins, resource ownership review, Project Knowledge plugin. Core Memory, lexical tool discovery and this optional FTS5 plugin are distinct; none is a built-in vector RAG pipeline.
7. Which orchestration claims are experimental? Host versus V8 Code Mode, measured Code Mode conditions, composition research

Document status and ownership

Status How to use it
Current contract Follow the owning schema/source and regression references. Current main behavior does not imply availability in every published release or Host.
Historical experiment or implementation record Preserve the source revision, environment, raw measurements and validation limits. Reported pass counts describe that run; they are not current acceptance evidence.
Unimplemented design direction Treat it as a proposal with explicit conditions, not a supported tool or an execution requirement.
Retired or replaced design Follow the named replacement. Merge useful evidence into its owner and update references before removing the redundant page.

docs/agent/ holds maintainer contracts and some explicitly marked historical audits; docs/architecture/ holds designs and source navigation; docs/implementation/ mixes current implementation contracts with dated acceptance; docs/experiments/, docs/design/ and docs/contribution-reports/ retain scoped research or staged work. Integrations and Plugins keep their consumer-specific guides beside their code. A directory, date, title or TODO count alone does not establish a document's status; mixed pages must identify the status of each part.

I want to contribute or release WebCodex

The references below cover repository policy and maintainer/internal contracts. The contract pages intentionally contain protocol fields, compatibility names, and implementation invariants that ordinary users should not need to learn.