Skip to content

docs: reconcile docs drift across CHANGELOG, API, CLI, MCP, and Journal (#290) - #307

Open
sshekhar563 wants to merge 1 commit into
qbtrix:devfrom
sshekhar563:docs/drift-290
Open

docs: reconcile docs drift across CHANGELOG, API, CLI, MCP, and Journal (#290)#307
sshekhar563 wants to merge 1 commit into
qbtrix:devfrom
sshekhar563:docs/drift-290

Conversation

@sshekhar563

Copy link
Copy Markdown
Collaborator

Resolves #290.

This PR reconciles accumulated documentation drift across 5 core documentation files following recent feature merges:

1. CHANGELOG.md

  • Added missing [Unreleased] entries for 6 merged PRs:
    • #255/#256: decision.outcome_attached journal action
    • #258: decision.completed + build_policy_event + build_completion_event for RFC 09
    • #264: Store episodic remember/note content verbatim (⚠️ user-visible behavior change)
    • #272: MemoryProvenance enum (HUMAN, AGENT) + Soul.curate_agent_procedures()
    • #228/#271: Cross-runtime test suite for PocketPaw, LangChain, and CrewAI

2. docs/api-reference.md

  • Documented provenance: MemoryProvenance = MemoryProvenance.HUMAN kwarg on Soul.remember()
  • Added documentation for Soul.curate_agent_procedures(similarity_threshold=0.6)
  • Documented MemoryProvenance enum (HUMAN, AGENT)

3. docs/org-journal-spec.md

  • Updated the Decisions action namespace list to include decision.completed and decision.outcome_attached alongside decision.graduated

4. docs/mcp-server.md

  • Corrected total MCP tool count from 28 → 39 in header and summary breakdown
  • Added documentation sections for previously undocumented MCP tools: soul_health, soul_cleanup, and soul_edit_core

5. docs/cli-reference.md

  • Added missing soul unpack command documentation section
  • Added missing soul delete command documentation section
  • Corrected soul recall --limit option flag from -l to -n
  • Fixed broken soul archive example syntax (--tiers ipfs --tiers arweave)

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