Skip to content

docs: audit and fix documentation inconsistencies - #197

Merged
avoidwork merged 1 commit into
mainfrom
docs/doc-audit-fixes
Jun 13, 2026
Merged

docs: audit and fix documentation inconsistencies#197
avoidwork merged 1 commit into
mainfrom
docs/doc-audit-fixes

Conversation

@avoidwork

Copy link
Copy Markdown
Owner

Description

Audit and resolve inconsistencies across README.md, docs/FLOWS.md, and docs/TUI_FLOWS.md. Aligns tool names, config values, flow diagrams, and command references with current implementation.

Type of Change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactor (no functional changes)
  • Performance improvement
  • CI / build / tooling

Testing

No code changes — documentation-only updates verified by visual inspection against current source code.

Coverage

  • 100% line coverage maintained (N/A — no code changes)

Checklist

  • npm run lint passes
  • Tests pass with 100% line coverage
  • No forbidden patterns used
  • Conventional Commit style applied

Detailed Changes

README.md

  • Updated tool names to match current implementation (execute_code, web_search, web_extract, image_generate, vision_analyze, text_to_speech, mixture_of_agents, cronJob)
  • Updated config table: rate limit 120 → 60, memory limit 128mb → 512m, maxReadSize 10mb → 1mb
  • Added skillScanPaths and trustProjectSkills config entries
  • Added ephemeral.ttlDays and ephemeral.maxEntries config entries
  • Added schedules.syncOnInit config entry
  • Updated sandbox process description from forked to spawned
  • Updated cron scheduler description to reflect system crontab delegation

docs/FLOWS.md

  • Added crontab sync block to main index.js flow (Cron.sync, Cron.add)
  • Added ensureSessionsDir and onboarding flow
  • Updated memory module exports (loadMemories, formatMemoriesForPrompt replacing cleanRetainedMemory, enforceMaxEntries)
  • Added GC init to startup flow
  • Updated ScheduleManager instantiation (maxConcurrent param deprecated)
  • Updated tool config building to include new params
  • Updated ReactAgent creation to include recursionLimit
  • Updated session config to use sessionState.getThreadId()
  • Updated sandbox spawn call (stdio removed ipc, added note about fork vs spawn)
  • Added clarifying note about fork() vs spawn() in sandbox

docs/TUI_FLOWS.md

  • Added new App props: scheduleManager, onboarding, onSaveSession, gcManager, gcTrigger
  • Updated command dispatch table: removed \:memory, \:context; added \:clear, \:new, \:gc
  • Added note clarifying which commands are actually registered vs handled elsewhere

@avoidwork avoidwork self-assigned this Jun 13, 2026
@avoidwork
avoidwork enabled auto-merge (squash) June 13, 2026 02:25
@avoidwork
avoidwork merged commit 01f5159 into main Jun 13, 2026
3 checks passed
@avoidwork
avoidwork deleted the docs/doc-audit-fixes branch June 13, 2026 02:26
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