Hi! Small docs inconsistency in the examples/ folder.
What happens
examples/README.md documents a tutorials folder and links to it, but examples/tutorials/ does not exist on main. Three references 404:
| File |
Line |
Link |
examples/README.md |
26 |
**[`tutorials`](./tutorials/)** |
examples/README.md |
43 |
- Explore `tutorials` for more complete workflows and extended use cases. |
examples/cookbook/README.md |
30 |
the [`tutorials`](../tutorials/) directory |
$ gh api repos/evidentlyai/evidently/contents/examples/tutorials
gh: Not Found (HTTP 404)
Every other entry in the "Folder structure" section (cookbook, service, grafana, datasets) resolves correctly — this is the only one that does not.
Why it looks like a leftover
The tutorials are not missing, they just are not in a subfolder. examples/README.md itself says so at line 7:
If you are new to Evidently, start with these three top-level tutorials:
...and links the three notebooks that live directly in examples/.
This traces back to the examples reorganisation in eb5d82a ("Examples update", #1853), which created the README and the three tutorials in the same commit — including moving examples/cookbook/tracing_with_service.ipynb up to examples/agentic_systems_tracing.ipynb. No tutorials/ directory was created or renamed away in that commit, so the folder-structure entry appears to describe a layout the reorganisation ended up not using.
Suggested fix
Point the three references at the top-level notebooks that already serve this purpose, rather than adding an empty folder. Happy to be told you would rather have an actual examples/tutorials/ directory instead — in that case ignore the PR.
I have opened a PR with the doc-only change.
(Unrelated and not touched by the PR, just flagging in case it is useful: examples/future_examples/ exists but is not listed in the folder structure — I assumed that is deliberate.)
Hi! Small docs inconsistency in the
examples/folder.What happens
examples/README.mddocuments atutorialsfolder and links to it, butexamples/tutorials/does not exist onmain. Three references 404:examples/README.md**[`tutorials`](./tutorials/)**examples/README.md- Explore `tutorials` for more complete workflows and extended use cases.examples/cookbook/README.mdthe [`tutorials`](../tutorials/) directoryEvery other entry in the "Folder structure" section (
cookbook,service,grafana,datasets) resolves correctly — this is the only one that does not.Why it looks like a leftover
The tutorials are not missing, they just are not in a subfolder.
examples/README.mditself says so at line 7:...and links the three notebooks that live directly in
examples/.This traces back to the examples reorganisation in eb5d82a ("Examples update", #1853), which created the README and the three tutorials in the same commit — including moving
examples/cookbook/tracing_with_service.ipynbup toexamples/agentic_systems_tracing.ipynb. Notutorials/directory was created or renamed away in that commit, so the folder-structure entry appears to describe a layout the reorganisation ended up not using.Suggested fix
Point the three references at the top-level notebooks that already serve this purpose, rather than adding an empty folder. Happy to be told you would rather have an actual
examples/tutorials/directory instead — in that case ignore the PR.I have opened a PR with the doc-only change.
(Unrelated and not touched by the PR, just flagging in case it is useful:
examples/future_examples/exists but is not listed in the folder structure — I assumed that is deliberate.)