-
Notifications
You must be signed in to change notification settings - Fork 294
docs: fix broken tutorial links and remove redundant file #5154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- 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
There was a problem hiding this 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 inmkdocs.yml
that mapsresources/tutorials.md
toexamples/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
- [: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/) |
There was a problem hiding this comment.
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.
Changes Made
Fixed broken documentation links that were preventing users from navigating to examples from the quickstart guide:
/examples/
instead of the old/resources/tutorials/
pathdocs/resources/tutorials.md
file since a redirect is already configured in mkdocs.ymlChecklist
Internal
Closes https://linear.app/eventual/issue/EVE-858/broken-links-on-quickstart