Skip to content

Conversation

ykdojo
Copy link
Contributor

@ykdojo ykdojo commented Sep 8, 2025

Changes Made

Fixed broken documentation links that were preventing users from navigating to examples from the quickstart guide:

  • Updated quickstart.md to link to /examples/ instead of the old /resources/tutorials/ path
  • Fixed broken reference in custom-code/udfs.md to point to the new examples location
  • Removed redundant docs/resources/tutorials.md file since a redirect is already configured in mkdocs.yml

Checklist

  • Documentation builds and is formatted properly

Internal

Closes https://linear.app/eventual/issue/EVE-858/broken-links-on-quickstart

- Changed from resources/tutorials.md to ../examples/
- Updated wording from "Try your hand at some Tutorials" to "Explore our Examples to see Daft in action"
- Fixed individual example links to use directory paths without .md extension
- Ensures links correctly navigate to http://127.0.0.1:8000/en/stable/examples/
- Fixed broken link in custom-code/udfs.md to point to examples/document-processing.md
- Removed redundant docs/resources/tutorials.md since redirect is already in place
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Summary

This PR fixes broken documentation navigation by updating tutorial links to use the new examples structure. The changes address a documentation reorganization where content was moved from /resources/tutorials/ to /examples/.

Specifically, the PR:

  • Updates the quickstart guide to link to the new examples directory structure (../examples/mnist/, ../examples/llms-red-pajamas/, etc.) instead of the old tutorial paths
  • Fixes a broken reference in the UDF documentation that points to the document processing example
  • Removes the redundant docs/resources/tutorials.md file, which was no longer needed since a redirect already exists in mkdocs.yml that maps resources/tutorials.md to examples/index.md

This change aligns with the existing redirect configuration and ensures users can successfully navigate from documentation to working examples. The restructuring improves documentation maintenance by eliminating duplicate content and establishing a single source of truth for example listings in the examples directory.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only fixes broken documentation links
  • Score reflects straightforward documentation updates with no code logic changes
  • No files require special attention as all changes are simple link updates and file cleanup

3 files reviewed, no comments

Edit Code Review Bot Settings | Greptile

Comment on lines +542 to +546
- [:material-image-edit: **MNIST Digit Classification**](../examples/mnist/)
- [:octicons-search-16: **Running LLMs on the Red Pajamas Dataset**](../examples/llms-red-pajamas/)
- [:material-image-search: **Querying Images with UDFs**](../examples/querying-images/)
- [:material-image-sync: **Image Generation on GPUs**](../examples/image-generation/)
- [:material-window-closed-variant: **Window Functions in Daft**](../examples/window-functions/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also like to replace these tutorials with our newer, more representative tutorials. i.e. document processing, audio transcription, embeddings.

@ykdojo ykdojo merged commit 71d75f8 into main Sep 8, 2025
29 checks passed
@ykdojo ykdojo deleted the fix/quickstart-examples-links branch September 8, 2025 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants