-
[NA] [DOCS] Opik 2.0 docs refactor: v2 pages, versioning, and navigation (#6339)
frostbyte_neo 发布于
2026-04-16 20:19:50 +00:00 -
Docs WIP
-
Docs WIP
-
[NA] [DOCS] Add Opik 2.0 project-scope notes and project_name to code samples (#6165)
-
[NA] [DOCS] Add Opik 2.0 project-scope notes and project_name to code samples
Add callouts and project_name/projectName parameters across docs to
reflect that experiments, datasets, and prompts are project-scoped in Opik 2.0.- Add blocks to evaluation, prompt engineering, tracing integrations,
agent optimization, cookbook, and TypeScript SDK reference pages - Add project_name="my-project" to Python SDK calls: get_or_create_dataset(),
evaluate(), evaluate_prompt(), opik.Prompt(), opik.ChatPrompt() - Add projectName: "my-project" to TypeScript SDK calls: getOrCreateDataset(),
evaluate(), evaluatePrompt(), createPrompt(), createChatPrompt() - Change → for existing Opik 2.0 callouts for consistency
- [NA] [DOCS] Add opik.configure(project_name=) to mixed tracing+evaluation snippets
Ensure code samples that combine @track with evaluate()/dataset API calls
use opik.configure(project_name=) so all data consistently lands in the
same project, addressing reviewer feedback on PR #6165.-
[NA] [DOCS] Add warning about project consistency when mixing @track with API calls
-
Doc updates
-
Rewrite agent config docs: correct code snippets, human-readable prose
- Add @opik.track / track() to every fetch example (was missing — would confuse readers)
- Fix TS fallback examples: use plain objects instead of client.createPrompt() calls
- Structure getting-started as a clear two-step happy path (create → fetch)
- Rewrite fallback explanation as a narrative instead of bullet list
- Remove all TODO placeholders from overview and version_control
- Match writing voice to existing v1 docs (direct, dev-to-dev, benefit-first)
https://claude.ai/code/session_01MXMp1pctbziyksXGfwtSmH
- [NA] [DOCS] Rewrite v2 docs: observability, evaluation, prompt engineering, Ollie, and development sections
Rewrites and adds new v2 documentation pages covering observability, evaluation,
prompt engineering, self-improving agents (Ollie), and development overview.
Updates latest.yml navigation and adds supporting images/videos.Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
-
Optimised images with calibre/image-actions
-
[NA] [DOCS] Add write-docs skill for Fern MDX documentation authoring
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
- [NA] [DOCS] Add flywheel image for self-improving agents overview
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
-
Optimised images with calibre/image-actions
-
[NA] [DOCS] Decouple v1 and latest doc namespaces
- Copy 221 v1 .mdx files used by latest.yml into docs-v2/ mirroring the
new latest URL paths so each version has its own content - Update latest.yml to point to the docs-v2 copies
- Rewrite internal links in latest copies to use the new latest URLs
(with /v1/ fallback for pages that only exist in v1) - Rewrite internal links in v1 docs to use /v1/ prefix so v1 readers
stay in v1 - Fix log-traces typo in batching-and-updates troubleshooting page
Resolves the broken-link 404s reported on the v2 docs preview where
v1-style bare paths didn't resolve in either namespace after the v2
versioning was introduced.Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
- [NA] [DOCS] Use absolute /img/ paths in latest faq and sdk_configuration
Relative ../img/ paths break when files are mounted at deeper URLs.
Switch to absolute /img/ which Fern resolves consistently.Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
Co-authored-by: Claude Opus 4.6 noreply@anthropic.com
Co-authored-by: Thiago dos Santos Hora thiagoh@comet.com
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>下载附件
-