Skip to content

docs(build-an-oracle): document prompt anatomy, OracleConfig.prompt f…#24

Merged
ig-shaun merged 4 commits into
mainfrom
feature/ora-254-docsbuild-an-oracle-document-prompt-anatomy
Jun 4, 2026
Merged

docs(build-an-oracle): document prompt anatomy, OracleConfig.prompt f…#24
ig-shaun merged 4 commits into
mainfrom
feature/ora-254-docsbuild-an-oracle-document-prompt-anatomy

Conversation

@youssefhany-ixo

Copy link
Copy Markdown
Collaborator

…ields, and memory pre-fetch

  • Expand createoracleapp.mdx config accordion with full prompt sub-field docs (opening, communicationStyle, capabilities) including fallback logic
  • Add understand/prompt-anatomy.mdx: 15-section prompt structure, always vs conditional blocks, 5000-token Tier-1 budget, and what config.ts actually needs to provide vs what the runtime handles automatically
  • Add 'How memory reaches the prompt' section to memory.mdx documenting UserContextFetcher eager pre-fetch (6 slots, 5-min cache, turn-1 availability) — previously entirely undocumented
  • Wire prompt-anatomy into docs.json nav under Deep dive

Closes ORA-254

youssefhany-ixo and others added 2 commits June 2, 2026 20:52
…ields, and memory pre-fetch

- Expand createoracleapp.mdx config accordion with full prompt sub-field
  docs (opening, communicationStyle, capabilities) including fallback logic
- Add understand/prompt-anatomy.mdx: 15-section prompt structure, always
  vs conditional blocks, 5000-token Tier-1 budget, and what config.ts
  actually needs to provide vs what the runtime handles automatically
- Add 'How memory reaches the prompt' section to memory.mdx documenting
  UserContextFetcher eager pre-fetch (6 slots, 5-min cache, turn-1
  availability) — previously entirely undocumented
- Wire prompt-anatomy into docs.json nav under Deep dive

Closes ORA-254

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
…as check

\bJAMBO PWA\b matched inside the canonical term "JAMBO PWA SDK", causing
false positives on files that already used the correct form. Added the same
lookahead exception (?!\s+SDK) already used for the Matrix Client / Matrix
Client SDK pair.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@mintlify

mintlify Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
ixoworld 🟢 Ready View Preview Jun 2, 2026, 5:58 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…aders

Section names in the table and detail blocks were written as
"## Operating principles" etc., causing the ## to render as literal
text in the browser. Cleaned to plain names matching Mintlify conventions.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
…natomy

- Rewrite all 15 section detail headers in prompt-anatomy.mdx to use
  plain human-readable names — removes ALL_CAPS internal identifiers
  (CAPABILITIES_NOTE, COMPOSIO_CONTEXT, etc.), stray ## syntax, {DID}
  template literals, and [--- ...] bracket notation that rendered as
  literal text in Mintlify
- Replace ### headings inside the config Accordion in createoracleapp.mdx
  with bold text — nested headings break Mintlify accordion rendering

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@ig-shaun ig-shaun merged commit 9cbdf6e into main Jun 4, 2026
4 checks passed
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.

2 participants