Daft icon indicating copy to clipboard operation
Daft copied to clipboard

docs: Updated examples index to bento style, added voice_analytics_example,…

Open everettVT opened this issue 1 month ago • 2 comments

Changes Made

Alters examples tab from grid of images to a bentobox with roboto-mono font as well as:

  1. moves long document processing tutorial off of docs (kept in repo)
  2. adds voice analytics example (notebook version of blogpost)
  3. Fixes multimodal usage example in prompt.
  4. updates nav to reflect above changes
  5. Updates a few lines in old notebooks for me to add to daft-examples later.

Checklist

  • [x] Documented in API Docs (if applicable)
  • [x] Documented in User Guide (if applicable)
  • [x] If adding a new documentation page, doc is added to docs/mkdocs.yml navigation
  • [x] Documentation builds and is formatted properly

everettVT avatar Nov 15 '25 07:11 everettVT

Greptile Overview

Greptile Summary

This PR modernizes the examples documentation with a new bento-style layout and adds a comprehensive voice AI analytics tutorial. The changes include:

  • Redesigned examples index from image grid to modern bento-box layout with Roboto Mono font
  • Added new voice analytics example demonstrating audio transcription, summaries, translations, and embeddings
  • Replaced document-processing example with voice_ai_analytics in navigation
  • Enhanced multimodal usage documentation in prompt.md with runnable uv script headers
  • Updated notebooks to use new @daft.cls() and @daft.method() API patterns

The main issue is that the new voice analytics tutorial imports a non-existent transcription_schema module which will cause the code examples to fail.

Confidence Score: 3/5

  • Safe to merge after fixing the missing import that will break code examples
  • The PR makes solid documentation improvements but has a critical syntax issue - the voice analytics example imports a non-existent module which would prevent users from running the code. All other changes are documentation/style updates that look good.
  • docs/examples/voice_ai_analytics.md requires fixing the missing transcription_schema import before merge

Important Files Changed

File Analysis

Filename Score Overview
docs/examples/voice_ai_analytics.md 3/5 New voice analytics tutorial - missing import for transcription_schema module
docs/examples/index.md 5/5 Redesigned examples page from grid to bento-style layout with roboto-mono font
docs/ai-functions/prompt.md 4/5 Improved multimodal example with uv script headers and better formatting, removed extraneous code

Sequence Diagram

sequenceDiagram
    participant User
    participant ExamplesIndex as Examples Index Page
    participant VoiceAnalytics as Voice AI Analytics Tutorial
    participant PromptDocs as Prompt.md Documentation
    participant Notebooks as Tutorial Notebooks

    User->>ExamplesIndex: Navigate to examples
    ExamplesIndex->>ExamplesIndex: Render bento-style layout
    ExamplesIndex->>ExamplesIndex: Apply Roboto Mono font
    User->>VoiceAnalytics: Click voice analytics card
    VoiceAnalytics->>VoiceAnalytics: Load tutorial content
    VoiceAnalytics->>VoiceAnalytics: Import transcription_schema (ERROR)
    VoiceAnalytics-->>User: Code example fails
    
    User->>PromptDocs: View multimodal examples
    PromptDocs->>PromptDocs: Parse uv script headers
    PromptDocs->>User: Display runnable code
    
    User->>Notebooks: Run tutorial notebooks
    Notebooks->>Notebooks: Use @daft.cls() API
    Notebooks->>Notebooks: Use @daft.method() decorator
    Notebooks->>User: Execute successfully

greptile-apps[bot] avatar Nov 15 '25 07:11 greptile-apps[bot]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 70.36%. Comparing base (5343e9b) to head (3c30df7). :warning: Report is 17 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5587      +/-   ##
==========================================
+ Coverage   70.04%   70.36%   +0.32%     
==========================================
  Files        1012     1012              
  Lines      131198   130612     -586     
==========================================
+ Hits        91893    91909      +16     
+ Misses      39305    38703     -602     

see 14 files with indirect coverage changes

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Nov 15 '25 07:11 codecov[bot]

@ykdojo any chance you can add your review here?

everettVT avatar Nov 18 '25 18:11 everettVT

Checking now. I think it'll be helpful to separate this PR to multiple ones so only related changes are in each PR.

ykdojo avatar Nov 18 '25 21:11 ykdojo