komlevv-komlevv-Align-ComfyUI/docs/INDEX.md

Documentation index

• Status: stable
• Scope: registry of agent-facing docs, read order, lifecycle, and active task references
• Applies to: docs/**, root instruction files, nested agent docs
• Source of truth level: registry
• Last verified commit: 9bb835c68f9a68ecccdbeae32bd41382a1eb3556
• Update when: a new doc is added, a doc is superseded or archived, read order changes, or a different task becomes active
• Supersedes: none
• Superseded by: none

Purpose

This file is the registry for the repository's multi-file context system.

Use it to determine:

• what each document is for
• which documents are stable versus task-specific
• what to read for a given kind of task
• which task or handoff docs are current
• which docs are superseded or archived

Read order

Always read first

1. CLAUDE.md
2. AGENTS.md
3. docs/INDEX.md

Then read by task type

Frontend subsystem change under web/js/**

• if the task may require repository access through GitHub, verify the GitHub connector before deeper code analysis
• if that connector check fails or is ambiguous, ask the human whether to continue without it before proceeding
• relevant docs/features/*.md
• relevant nested web/js/**/AGENTS.md
• docs/PROJECT_ARCHITECTURE.md
• docs/COMPATIBILITY.md
• after the first working pass, re-review the solution quality and performance before concluding the task

GitHub connector read/write workflow

• docs/tools/github_connector.md

Active task continuation

• current file in docs/tasks/
• relevant file in docs/handoffs/ if the task builds on a prior branch/session

Stable docs

Root instruction layer

• AGENTS.md — canonical repository-wide agent rules
• CLAUDE.md — thin Claude-specific entrypoint

Stable architecture / compatibility

• docs/PROJECT_ARCHITECTURE.md
• docs/COMPATIBILITY.md

Stable subsystem docs

• docs/features/align_toolbar.md

Stable operational docs

• docs/tools/github_connector.md

Stable decision logs

• docs/DECISIONS/0001-context-governance.md

Nested local guardrails

• web/js/AGENTS.md

Active task docs

None.

Active handoff docs

None.

Lifecycle rules

• exactly one task doc should be active for a given narrow problem
• handoff docs should represent completed or paused session state, not competing live task truth
• superseded docs must say what replaced them
• archived docs should no longer be read by default

Source-of-truth reminder

Use this factual precedence:

1. current code in target branch
2. current active task doc
3. relevant feature doc
4. architecture and compatibility docs
5. README
6. archived or superseded docs

If code and docs disagree, update the doc.