v5.0.2-beta.31 (rebased)#201
Open
rakesh-snippyly wants to merge 5 commits into
Open
Conversation
…rch, agent execution history Clean rebase of PR #180 onto current main, including the house-style and accuracy pass against the internal developer guides: - ai/approval-engine/developer-guide.mdx: hands-on workflow tutorial (create definition, dispatch, record decision, get outcome). - ai/memory/overview.mdx (new): concept-first page covering what Memory is, how it works, core concepts, data provenance, and limitations. - ai/memory/developer-guide.mdx: hands-on tutorial (add knowledge, ask, search, suggest); concepts live in the overview. - ai/approval-engine/overview.mdx: inbound webhook handler section, per-tenant storeDbId note, Developer Guide card. - REST API references for listAgentExecutions and memory knowledge/search. - Changelog entry for 5.0.2-beta.31 in chronological position, with backend-only items removed and Memory bullets linked to the new pages. - Doc-gaps working file kept under .claude/logs/ (build-ignored). Replaces #180, whose branch predates main's beta.32/33 changelog entries and conflicts with main in the changelog region. https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Open
…t Memory REST reference, add Beta labels - Merge developer guides into Setup, matching the sitewide overview/setup/customize-behavior convention: approval-engine setup now carries the full tutorial (cURL steps, realistic parallel-review example, webhook receiver details, event traces); memory developer-guide renamed to setup. All cards, changelog bullets, and docs.json links updated; no redirects needed since the developer-guide URLs never shipped. - Build out the Memory REST API reference from the internal memory-api-reference: 20 new pages across Search & Q&A (search, judgments/query, ask, suggest), Knowledge (upload-url, ingest, ingest-status, list, rules, download, update, delete), Insights (profiles, patterns, stats), and Alerts (list, dismiss, action, config get/update). Memory setup now links to them. - Approval Engine REST coverage audited: all 14 public endpoints already have pages; inbound webhook surfaces remain undocumented (no response schemas in source) and are tracked in the gaps log. - Add Beta labels: "Memory (Beta)" page title and "(Beta)" on the Approval Engine and Memory sidebar groups. https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn
- ingest: spell out the supported mimeType values instead of 'supported types' - alerts/dismiss: fix copy-pasted param wording - search: note example decision filter values https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn
- drop Staging base URL row and /v1/ versioning note from both setup pages - replace <Steps> components with numbered ### headings on setup tutorials and plain ### headings on the Memory overview pipeline https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn
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
2 participants
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.
Clean rebase of #180 onto current main, plus a house-style and accuracy pass against the internal Approval Engine and Memory developer guides. Diff is exactly the 12 intended files; #180's branch predates main's beta.32/33 changelog entries and conflicts with main in the changelog region, so this PR replaces it (close #180 when merging this one).
What's in it
ai/approval-engine/developer-guide.mdx): hands-on tutorial; author a workflow, dispatch a run, record a decision, receive the outcome (webhooks + polling).ai/memory/overview.mdx, new): concept-first page; what Memory is, how it works, core concepts, where the data comes from, limitations.ai/memory/developer-guide.mdx): hands-on tutorial; add knowledge, ask, search, suggest. Concepts moved to the overview.storeDbIdnote, Developer Guide card.listAgentExecutions,memory/knowledge/search.Style pass applied: no em-dashes, second person, callouts instead of bold asides, internal terminology removed (Cloud Function/onCall naming, Firestore collection names), observable behavior over implementation detail.
https://claude.ai/code/session_015qRRK7w4nbVX64YSGJDWZn
Generated by Claude Code