Guides are listed in reading order. Each one has one main topic and links to the others instead of repeating them.
| # | Guide | Read it when you want to… |
|---|---|---|
| 1 | Getting started | install the toolkit, authenticate providers, and run a first cycle |
| 2 | Workflows | choose between single skills, the manual cycle, the orchestrators, and the runtime driver |
| 3 | Skills reference | know what each of the sixteen skills takes, does, and returns |
| 4 | Review lifecycle | understand REV-xxx findings, severities, statuses, dispositions, and run lines |
| 5 | Verification | know what counts as evidence and when a stage stops to ask |
| # | Guide | Read it when you want to… |
|---|---|---|
| 6 | Routing and models | change models, executors, efforts, or fallbacks, or try Jev or a calibration |
| 7 | Configuration | look up every .code-cycle.yml key, invocation parameter, CLI flag, and environment variable |
| 8 | Providers | combine GitHub, Plane, or Jira with GitHub or Bitbucket |
| 9 | Telemetry and cc-stats |
know what is recorded locally and read the report |
| 10 | Optional workspace tools | know which host tools help, what they are not, and how dispatched stages see them |
| Document | Contents |
|---|---|
| CodeCycleToolkit 2.0 roadmap | Approved strategy, execution modes, decisions, issue dependencies and milestones; planned capabilities are not implementation claims |
| Role workspace policy | The write permission each dispatched role has, and which executors can enforce it |
| Host permissions | Each stage's closed command table, how Claude and Codex enforce it, their limits, and the opt-in global set |
| Stage registry and execution plan | Static stage/control metadata and the validated, versioned ExecutionPlan contract |
| Dependency preparation | Frozen Node installs, user-selected tools/integrations, registry access and setup evidence |
| Native preparation campaign | Observed native validation failures and the remaining host validation for #279 |
| Instrumentation internals | Design reference: the comment record, paired review, routing v1, executor dispatch, telemetry schema |
| Codex plugin adapter contract | Discovery, handoff, and failure rules for Claude + Codex mode |
| ECC comparison | Dated comparison with the toolkit code and backlog; architectural ideas to adopt, in Spanish |
| Repository Knowledge & Learning | Approved design proposal: discovery, obligations, evidence, authority and cost controls; not an implemented capability |
| Knowledge Discovery backlog | Ten implementation deliveries, dependencies and traceability to the design acceptance criteria; learning remains deferred |
| Plan de instrumentación y routing | Historical design plan, in Spanish. Superseded by the documents above where they differ. |
- CHANGELOG: released and unreleased changes
- CONTRIBUTING: authoring rules, validator, release checklist, and the CI fast path for non-code changes
- SECURITY: how to report a vulnerability