Skip to content

docs: rewrite tools/idempotency/hooks/streaming/mcp + new homepage hero + Capabilities + dark-mode diagrams#29

Merged
fede-kamel merged 1 commit into
mainfrom
docs/concept-rewrites-and-brand-polish
May 2, 2026
Merged

docs: rewrite tools/idempotency/hooks/streaming/mcp + new homepage hero + Capabilities + dark-mode diagrams#29
fede-kamel merged 1 commit into
mainfrom
docs/concept-rewrites-and-brand-polish

Conversation

@fede-kamel
Copy link
Copy Markdown
Contributor

@fede-kamel fede-kamel commented May 2, 2026

Summary

Three layers of work landing together — the next batch of concept-page rewrites, a complete homepage hero/body iteration, and the "Feature matrix" → "Capabilities" rename with a new Oracle-distinctive admonition style.

Concept pages (template-aligned, 74→156, 56→138, 82→148, 68→140, 51→139)

  • `tools.md`, `idempotency.md`, `hooks.md`, `streaming.md`, `mcp.md` — each rewritten to pitch / when to pick / getting started / runnable capabilities / gotchas / source.

Homepage rewrite

  • H1: `# Build agents that reason and solve together.` — verb-led, two-beat, captures both pillars in one phrase.
  • Subhead: `The Oracle Gen AI Multi-Agent Reasoning SDK.` — matches the logo wordmark; Oracle-anchored category claim.
  • Body: reasoning lives inside the loop (`Reflexion` / `Grounding` / `Causal`); six-shape verb chain (Compose / Orchestrate / Swarm / Handoff / StateGraph / Functional + A2A); Oracle proof closer.
  • "Six things you can ship" section — developer-narrative ordering (Reason → Act → Coordinate → Mesh → Decide → Deploy), benefit-led H3 titles, 14–20-line code blocks with real imports + commented output, descriptive concept + tutorial links (no `Tutorial 03` labels).
  • H1 `margin-bottom` tightened from `1.4rem` → `0.6rem`.
  • Drops decorative `title='travel_concierge.py'` from the hero code block.

Capabilities (renamed from "Feature matrix")

  • Honest naming — single-product capability list, not a comparison matrix.
  • New `!!! oracle-distinctive "Distinctive to locus"` admonition (Oracle-red border + sand-tinted gradient + red star icon, defined in `docs/stylesheets/locus.css`) calls out the six wedge features at a glance.
  • Every section uses the same three-column table: Feature / What it does / Surface (+ concept link).
  • `mkdocs.yml` nav label updated.

Dark-mode diagrams

  • Architecture SVGs (`agent-loop`, `multi-agent-patterns`, the per-pattern SVGs under `img/patterns/`, `architecture`, `sequence-26ai`) were authored against a light background; dark-mode rendering was hiding the dark-grey strokes. Added a near-white card in the `slate` scheme.

Model id fix mirrored

`openai.gpt-5.5` → `openai.gpt-5` in homepage code blocks, README, and `docs/concepts/providers/openai.md`. Same fix shipping in PR #38 across the rest of the codebase.

Test plan

  • `hatch -e docs run mkdocs build --strict` — clean (zero warnings, all anchors valid)
  • `pre-commit run --files docs/index.md docs/FEATURES.md docs/stylesheets/locus.css mkdocs.yml README.md docs/img/sequence-26ai.svg docs/concepts/providers/openai.md` — codespell, markdownlint, gitleaks, doc8 all pass
  • DCO sign-off
  • Verified light + dark mode rendering on localhost preview

@oracle-contributor-agreement oracle-contributor-agreement Bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label May 2, 2026
@fede-kamel fede-kamel force-pushed the docs/concept-rewrites-and-brand-polish branch from 5cefbfd to 11d7aab Compare May 2, 2026 00:58
@fede-kamel fede-kamel force-pushed the docs/concept-rewrites-and-brand-polish branch from 11d7aab to 14962e9 Compare May 2, 2026 02:07
@fede-kamel fede-kamel changed the title docs: rewrite tools/idempotency/hooks/streaming/mcp + drop hero filename docs: rewrite tools/idempotency/hooks/streaming/mcp + tighten hero + dark-mode diagrams May 2, 2026
…ro + Capabilities + dark-mode diagrams

Concept-page rewrites — same template as the provider pages: pitch /
when to pick / getting started / capabilities (each runnable) /
gotchas / source. Pages sized 74→156, 56→138, 82→148, 68→140,
51→139.

Homepage rewrite:
- H1 → "Build agents that reason and solve together." (verb-led, two
  beats, captures both reasoning + multi-agent pillars).
- Subhead → "The Oracle Gen AI Multi-Agent Reasoning SDK." (matches
  the logo wordmark, Oracle-anchored category claim).
- Body → reasoning lives inside the loop (Reflexion / Grounding /
  Causal) + six-shape verb chain (Compose / Orchestrate / Swarm /
  Handoff / StateGraph / Functional / A2A) + Oracle proof closer.
- "Six things you can ship" section — developer-narrative ordering
  (Reason → Act → Coordinate → Mesh → Decide → Deploy), benefit-led
  H3 titles, 14–20-line code blocks with real imports + commented
  output, descriptive concept + tutorial links (no opaque "Tutorial
  03" labels).
- H1 margin tightened (1.4rem → 0.6rem) so subhead sits closer.
- Drop title='travel_concierge.py' from the hero code block.

Capabilities page (renamed from "Feature matrix"):
- Honest naming — it's a capability list, not a comparison matrix.
- New top-of-page Oracle-distinctive admonition (Oracle-red border +
  sand-tinted gradient + red star icon, defined in CSS) calls out
  the six wedge features at a glance.
- Every section uses the same 3-column table (Feature / What it does
  / Surface + concept link). Drops the prose dumps.
- mkdocs.yml nav label updated.

Dark-mode diagrams:
- Architecture SVGs (agent-loop, multi-agent-patterns, the
  per-pattern SVGs under img/patterns/, architecture, sequence-26ai)
  were authored against a light background; dark-mode rendering hid
  the dark-grey strokes. Added a near-white card in slate scheme.

Model id fix mirrored: openai.gpt-5.5 → openai.gpt-5 in homepage
code blocks, README, and openai provider doc. (Same fix shipping
in PR #38 across the rest of the codebase.)

Signed-off-by: Federico Kamelhar <federico.kamelhar@oracle.com>
@fede-kamel fede-kamel force-pushed the docs/concept-rewrites-and-brand-polish branch from 14962e9 to 9db72dc Compare May 2, 2026 05:08
@fede-kamel fede-kamel changed the title docs: rewrite tools/idempotency/hooks/streaming/mcp + tighten hero + dark-mode diagrams docs: rewrite tools/idempotency/hooks/streaming/mcp + new homepage hero + Capabilities + dark-mode diagrams May 2, 2026
@fede-kamel fede-kamel merged commit 8d50944 into main May 2, 2026
10 checks passed
@fede-kamel fede-kamel deleted the docs/concept-rewrites-and-brand-polish branch May 2, 2026 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant