Skip to content

Dev to main, 27th Aug, 2026 - #838

Merged
khushalsonawat merged 11 commits into
mainfrom
dev
Aug 27, 2026
Merged

Dev to main, 27th Aug, 2026#838
khushalsonawat merged 11 commits into
mainfrom
dev

Conversation

@abhijaisrivastava15

Copy link
Copy Markdown
Contributor

Summary

Promotion PR. Everything in it is already reviewed and merged to dev in #786; this moves it to main so it deploys to prod.

The payload is one cookbook page, instrument-and-verify, plus the checker script it tells the reader to download and the three captures it embeds. main currently serves the cookbook index but not this page, so the quickstart is live on dev and invisible in prod.

Why this is needed

.github/workflows/deploy.yml builds and deploys on push to main only. Merging #786 into dev therefore shipped nothing to docs.futureagi.com.

Checked against prod just now:

GET https://docs.futureagi.com/docs/cookbook                                -> 200
GET https://docs.futureagi.com/docs/cookbook/quickstart/instrument-and-verify -> 404
GET https://docs.futureagi.com/fi_verify.py                                -> 404

The second 404 is the page itself. The third one matters more than it looks: Step 2 of the page instructs the reader to run

curl -fsSL https://docs.futureagi.com/fi_verify.py -o observability/futureagi/fi_verify.py

so until main carries public/fi_verify.py, anyone following the cookbook from the live site hits a 404 on the first command that fetches anything.

What changed

Nothing was authored in this PR. The 11 commits and 8 files below are the full main...dev delta.

File
src/pages/docs/cookbook/quickstart/instrument-and-verify.mdx new, +694. The quickstart itself
public/fi_verify.py new, +252. The checker the page tells you to curl
public/images/docs/cookbook-instrument-and-verify/trace-list.png new capture
public/images/docs/cookbook-instrument-and-verify/trace-tree.png new capture
public/images/docs/cookbook-instrument-and-verify/session.png new capture
src/lib/navigation.ts +1. Sidebar entry for the new page
src/pages/docs/cookbook/index.mdx +1/-1. Index link
src/pages/docs/cookbook/platform/index.mdx +3. Cross-link from the platform section

Verification

  • Checksum the page prints is the checksum of the file that ships. The page prints 75ce8d9cb5bafa1cbeea42affe8b464433ab97e438a53410f27678855d484de7 as the expected shasum -a 256 of fi_verify.py. Ran it against the copy on this branch: identical, 11,925 bytes.
  • The three captures are real files, not empty placeholders. 154,218 / 187,436 / 322,787 bytes on branch.
  • Link audit passed on the way in. Link audit & redirect enforcement was green on docs(cookbook): instrument an existing app and verify it end to end #786 before Khushal merged it.
  • Rendered content was reviewed on dev. Images were checked on the dev deploy before the merge.

Blast radius

main...dev is 11 commits and 8 files, and every one of them belongs to this cookbook page. No unrelated work rides along.

The reverse compare dev...main is 0 files, so dev already contains everything on main. main gains exactly the 8 files above and loses nothing.

Rollback

Revert the merge commit. No schema, no migration, no config. The three prod URLs above return to their current state.

Note on the description template

The standard internal template asks for a tests table, a local suite-run screenshot and a test-run video. This is a docs promotion PR with no code and no test suite, and the content it carries was already reviewed and proved in #786, so those sections are deliberately omitted rather than filled with placeholders. The verification that does apply is above.

abhijaisrivastava15 and others added 11 commits August 5, 2026 12:11
Adds a cookbook quickstart that takes an app with no tracing to a verified
integration, covering both the Future AGI SDK and plain OpenTelemetry routes,
and ships fi_verify.py as a downloadable asset so the ten gates can be run
against the spans an app really produced.
Install, Tutorial with Steps, What you built with Check, Next steps, matching
the 34 sibling quickstarts rather than the one that deviates from them, and
restoring the done-condition and the blocked-report format the first draft
dropped.
…boundary

Time and difficulty were out of family: 45 min was the longest value on any of the 35
quickstarts and this page is half the length of the one that says 20. The Python
prerequisite read as a constraint on the reader's app; only fi_verify.attach() is
Python-bound, so the not-Python section now says what to do without it.
Runs the six steps against openai/openai-agents-python's customer service
agent and shows the trace list, the trace tree and the session from that run.

Name the track inside every listing so the two tracks stay separable when the
page is flattened to text, print the entry point the worked example adds, and
link the Colab notebook.
Resolve navigation.ts: dev restructured the cookbook nav into collapsible
groups while this branch added a single entry. Took dev's structure and
placed the entry first in Tracing and Debugging, ahead of Manual Tracing,
because the siblings in that group assume tracing already works.
/docs/tracing/auto moved to /docs/integrations/traceai. The three
references on this page were written before the move and now fail the
link audit.
The collector prices any span carrying a model and non-zero tokens, so
requiring a user-sent root cost failed an integration that leans on
platform pricing. G9 now asks that every LLM span is priceable or carries
its own cost, and names the double count when a root total sits on top.

Also: a real key ending 0000 made the wrong-key control the real key, so
preflight false-failed. Python floor is 3.11.
Cost: the collector prices LLM spans from the model and tokens (LiteLLM
table, then per-org rates) and a sent value wins. Names which surface
reads the root and which sum every span, so the roll-up is now the
unpriced-model path rather than the mainline.

Shape: full frontmatter, Future AGI as two words, 3.11 floor, badges on
blob/main, Troubleshooting table, one forward link instead of the card
grid, image captions and borderRadius, hub card and count.
All three are now uniform 3024x1890 full-window dark, taken off the same run
in the platform. The trace list is filtered to traces that carried tokens, so
the failed first attempt and the preflight probe are out of frame, and the
cost annotation now says what is actually true: our table keys this model as
groq/llama-3.3-70b-versatile, so nothing prices it and the number on the root
is the one the roll-up put there.
docs(cookbook): instrument an existing app and verify it end to end
@khushalsonawat
khushalsonawat merged commit 120d9af into main Aug 27, 2026
1 check 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