Skip to content

Reorganize documentation and correct outdated behavior descriptions - #43

Merged
aekeus merged 1 commit into
mainfrom
codex/docs-cleanup
Sep 16, 2026
Merged

aekeus merged 1 commit into
mainfrom
codex/docs-cleanup

Conversation

@aekeus

@aekeus aekeus commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

The README mixed quick-start instructions with detailed design and packaging material, while several guides described behavior that changed during the UI redesign. This update makes the README a short entry point and moves detailed instructions into linked setup, development and security guides.

Corrects descriptions of credentials and unconfigured builds, inspector tabs, bot conversation history, memory retention, file-content IPC, approval handling and CI coverage. The protocol guide now distinguishes historical milestones from current behavior and documents the existing renderer-crash and stdout-failure limitations without claiming automatic shutdown. No runtime code changes.

Validation: checked 57 local documentation links and anchors, verified 25 referenced npm scripts against package.json, and passed git diff --check. Runtime tests were not rerun for this documentation-only change. Commit is signed.

@aekeus
aekeus merged commit d5094e3 into main Sep 16, 2026
3 checks passed
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