Repository navigation
docs(topic-memory): align the guide with the shipped generic Artifact APIs - #1690
Merged
Merged
Conversation
… APIs
`docs/{en,zh}/docs/workflows/topic-memory.md` told readers that Topic Memory has no
generic create, update, delete, or retire endpoint and is not in the taggable family
list. Both claims contradict the contract and code shipped in v1.1.0:
`CreateTopicMemoryArtifactRequest` and `ReplaceTopicMemoryArtifactRequest` accept
`topic-memory`, `ArtifactReadFamily` covers all seven families, and `publish_artifact`
supports Topic Memory.
Document the generic write, revision, tag, and publication paths, replace the two stale
boundary bullets with what the interfaces actually refuse, and correct the same
read-only claim in `docs/{en,zh}/docs/workflows/artifacts.md`.
Teingi
reviewed
Sep 21, 2026
Teingi
left a comment
Member
There was a problem hiding this comment.
One non-blocking documentation clarification.
Contributor
Author
|
@Teingi I have completed all works which related to your comment. Please review again. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue or RFC does this PR close?
Closes #1685.
Rationale for this change
docs/{en,zh}/docs/workflows/topic-memory.mdtold readers that Topic Memory has no generic create, update, delete, or retire endpoint and is not in the Taggable Artifact family list. Neither claim holds for the contract atpowercontext-v1.1.0:CreateTopicMemoryArtifactRequestandReplaceTopicMemoryArtifactRequestaccepttopic-memory,ArtifactReadFamilycovers all seven families, andpublish_artifactsupports Topic Memory.docs/{en,zh}/docs/workflows/artifacts.mdrepeated the same read-only claim.Guidance that contradicts the interface it documents is worse than missing guidance: it tells integrators that shipped capabilities do not exist.
What changes are included in this PR?
scope.contributerequirement for creation, the fact that submitted content skips semantic generation and commits together with the head, chunks, and retrieval indexes, theIf-Matchrequirement for replacement, and the dualscope.adminrequirement for cross-Scope publication, which does not copy tags or direct Sources.docs/{en,zh}/docs/workflows/artifacts.md, and add Topic Memory to its family list and per-family workflow list.docs/{en,zh}/docs/rfcs/is left untouched. Those documents record the boundary as it stood when they were written, and a later RFC supersedes them.Are there any user-facing changes?
Documentation only. No behaviour, API, or persisted-format change.
How was this change tested?
openapi/powercontext.yaml:create_artifact(POST /v1/scopes/{scope_id}/artifacts),replace_artifact,get_artifact_revision,list_artifact_revisions, andpublish_artifact(POST /v1/artifact-publications).CreateTopicMemoryArtifactRequestrequiresfamily=topic-memorywithTopicMemoryWriteContent(title,summary,detail), andcreate_artifactdocuments that Topic Memory accepts complete text without semantic generation and commits its active head, chunks, and retrieval indexes atomically.DELETEoperation at all and thatretireexists only for Memory entries (/v1/memory/entries/retire), so the remaining boundary bullet states what is genuinely refused.BaseArtifactFamilyinsrc/powercontext/builtin/records.pycovers all seven families includingtopic-memory.AI usage statement
Built with an AI assistant (WorkBuddy), which read the contract and sources, drafted both locales, and verified each route and permission above. Claims that could not be confirmed from the contract or code were removed rather than softened.