docs: surface tutorial 31 (plugins) and fix stale source links#4
Merged
Conversation
- Add the Plugins tutorial link to the production track on the homepage. Pre-fix, examples/tutorial_31_plugins.py was orphaned with zero references in the docs site. - Add a 'See also' block to docs/concepts/hooks.md linking tutorials 5, 27, and 31, plus the user-facing concept pages (Retry, Safety, Observability) for the built-in hooks. - Fix the stale 'src/locus/integrations/mcp/' references in docs/index.md and docs/concepts/mcp.md — the package was flattened to src/locus/integrations/fastmcp.py. - Fix the stale 'agent_state.py' reference in docs/concepts/agent-loop.md — the file was consolidated into loop/runner.py. Audit: every github.com/oracle-samples/locus source / examples link across the docs tree now points at a path that exists in the repo. mkdocs build --strict passes with zero warnings.
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.
Small follow-up audit pass after PR #2 merged.
What's wrong on
maintodayexamples/tutorial_31_plugins.pyexists in the tree but has zero references anywhere in the docs site. New users who want the Plugin pattern have no entry point.src/locus/integrations/mcp/— the package was flattened tosrc/locus/integrations/fastmcp.py. Affected:docs/index.mdintrospect table +docs/concepts/mcp.mdsource pointer.src/locus/loop/agent_state.py— the state plumbing was consolidated intoloop/runner.py. Affected:docs/concepts/agent-loop.md.What this PR does
docs/concepts/hooks.mdlinking tutorials 5, 27, 31 and the user-facing concept pages (Retry, Safety, Observability).integrations/mcp/→integrations/fastmcp.pyreferences.loop/agent_state.py→loop/runner.pyreference.Audit context
I HEAD-checked all 64 unique
github.com/oracle-samples/locus/...source and example links across the docs tree. After this PR, every linked path resolves to a real file in the repo.Test plan
mkdocs build --strict— zero warnings, zero broken intra-site links.mkdocs serve.