docs: fix links to the non-existent examples/tutorials directory - #1906
Open
ankitranjan-dsai wants to merge 1 commit into
Open
docs: fix links to the non-existent examples/tutorials directory#1906ankitranjan-dsai wants to merge 1 commit into
ankitranjan-dsai wants to merge 1 commit into
Conversation
The examples README describes a `tutorials` folder and links to `examples/tutorials/`, but that directory does not exist. The three tutorials live directly in `examples/` — the same README calls them "three top-level tutorials" in the Start here section. Point the folder-structure entry and the cookbook README at those notebooks instead, and drop the "How to use these examples" bullet that duplicated the top-level tutorials line once the phantom folder is gone.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1905.
Docs only — no code, no tests affected.
Problem
examples/README.mddocuments atutorialsfolder and links toexamples/tutorials/, which does not exist onmain(gh api .../contents/examples/tutorials→ 404). Three references are dead:examples/README.md:26— the folder-structure entryexamples/README.md:43— the "How to use these examples" bulletexamples/cookbook/README.md:30— "thetutorialsdirectory"Every other folder-structure entry (
cookbook,service,grafana,datasets) resolves fine.Why this fix rather than adding the folder
The tutorials are not missing — they are at the
examples/root. The same README already calls them that at line 7 ("start with these three top-level tutorials") and at line 41, linkingagentic_systems_tracing.ipynb,llm_input_output_validation.ipynbandclassic_ml_validation.ipynbdirectly.eb5d82a (#1853) created the README and those three notebooks in one commit, moving
examples/cookbook/tracing_with_service.ipynbup toexamples/agentic_systems_tracing.ipynb. Notutorials/directory was created or renamed away there, so the entry looks like a description of a layout that was not used.Changes
examples/README.md— the folder-structure entry now points at the top-level tutorials (anchor link to the existing Start here section) and says where they live.examples/README.md— dropped thetutorialsbullet under "How to use these examples"; with the phantom folder gone it just restated the top-level-tutorials bullet directly above it.examples/cookbook/README.md— same reference repointed at Start here, keeping the existingexamplesfolder link.Wording is otherwise the authors’ own; no reflow, no trailing-newline changes.
Verification
Resolved every markdown link in both files, GitHub-style (leading
/against repo root, otherwise relative to the file), and checked the two#start-hereanchors against the actual headings:A repo-wide sweep of all 15 markdown files now reports 0 broken relative links; before this change it reported the 2 above.
If you would prefer an actual
examples/tutorials/directory instead, say so and I will close this.