docs: index all docs and add a Tutorials section#310
Merged
Conversation
index.md only linked 12 of the 19 docs under docs/. Readers entering from the index missed configuration, multimodal, demo, use-cases, benchmark, migration, and release notes. - Add a Tutorials section (Diátaxis 4th quadrant): everos-demo, use-cases - Reference: + configuration, + multimodal - How-to: + locomo_benchmark, + migration-to-1.0.0 - See also: + release-notes-1.1.0 Every docs/*.md (excluding the openapi.json artifact) is now linked. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dani1005
changed the title
dani1005
force-pushed
the
docs/index-add-missing-entries
branch
from
3be37a7 to
5381ddd
Compare
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
2 participants
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.
What
docs/index.mdonly linked 12 of the 19 docs underdocs/. Anyone entering the documentation through the index page silently missed 7 files — including core usage docs like configuration and multimodal.This PR makes the index complete and adds the missing Diátaxis quadrant.
Changes
everos-demo.md,use-cases.mdconfiguration.md,multimodal.mdlocomo_benchmark.md,migration-to-1.0.0.mdrelease-notes-1.1.0.mdAfter this change, every
docs/*.md(excluding the generatedopenapi.jsonartifact andindex.mditself) is linked from the index.Notes / judgment calls for reviewers
use-cases.mdis a product showcase rather than a strict guided tutorial; placed under Tutorials as the least-bad fit (learning/exploration oriented). Move to See also if you prefer.multimodal.mdstraddles Reference/How-to; filed under Reference since it documents modalities + payload formats.Scope
Docs only. No code, no API, no test changes.
🤖 Generated with Claude Code