Skip to content

docs: add Topic Memory guide - #1565

Open
frf12 wants to merge 1 commit into
oceanbase:masterfrom
frf12:codex/topic-memory-pr
Open

docs: add Topic Memory guide#1565
frf12 wants to merge 1 commit into
oceanbase:masterfrom
frf12:codex/topic-memory-pr

Conversation

@frf12

@frf12 frf12 commented Sep 11, 2026

Copy link
Copy Markdown
Member

Summary

Add a dedicated bilingual Topic Memory guide to the current documentation site.

Why

Topic Memory was described across the quickstart, configuration reference, and RFC, but it did not have a discoverable workflow page in the context-management sidebar. This change explains its lifecycle, configuration, verification flow, HTTP/MCP boundaries, prepared-context usage, and troubleshooting.

Related RFC: 1417 Topic Memory

Changes

  • Add English and Simplified Chinese Topic Memory workflow pages.
  • Add both pages to the Manage context sidebar and workflow index.
  • Document the current HTTP contract, exact Artifact references, asynchronous flush semantics, and Topic Memory context assembly.

Validation

  • make docs-test
  • Link validation: 195 public pages and 264 repository files
  • Static build and export verification: 794 public pages
  • Commit hooks: JSON, formatting, Ruff, and ty checks passed

User-facing or breaking changes

Documentation only; no runtime or API behavior changes.

AI usage

Built with Codex (GPT-5).

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