Skip to content

docs: surface tutorial 31 (plugins) and fix stale source links#4

Merged
fede-kamel merged 1 commit into
mainfrom
docs-link-fixes
Apr 28, 2026
Merged

docs: surface tutorial 31 (plugins) and fix stale source links#4
fede-kamel merged 1 commit into
mainfrom
docs-link-fixes

Conversation

@fede-kamel
Copy link
Copy Markdown
Contributor

Small follow-up audit pass after PR #2 merged.

What's wrong on main today

  • Tutorial 31 (plugins) is orphanedexamples/tutorial_31_plugins.py exists in the tree but has zero references anywhere in the docs site. New users who want the Plugin pattern have no entry point.
  • Stale source-path links — two references point at paths that no longer exist:
    • src/locus/integrations/mcp/ — the package was flattened to src/locus/integrations/fastmcp.py. Affected: docs/index.md introspect table + docs/concepts/mcp.md source pointer.
    • src/locus/loop/agent_state.py — the state plumbing was consolidated into loop/runner.py. Affected: docs/concepts/agent-loop.md.

What this PR does

  • Adds the Plugins tutorial link to the homepage's production track.
  • Adds a See also block to docs/concepts/hooks.md linking tutorials 5, 27, 31 and the user-facing concept pages (Retry, Safety, Observability).
  • Fixes the integrations/mcp/integrations/fastmcp.py references.
  • Fixes the loop/agent_state.pyloop/runner.py reference.

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.
  • All 37 tutorials are reachable from the docs site (pre-PR: 36 reachable, tutorial 31 orphaned).
  • Spot-checked the four edited pages render correctly in mkdocs serve.
  • Pre-commit hooks clean.

- 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.
@oracle-contributor-agreement oracle-contributor-agreement Bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Apr 28, 2026
@fede-kamel fede-kamel merged commit 53ef84b into main Apr 28, 2026
1 check passed
@fede-kamel fede-kamel deleted the docs-link-fixes branch April 28, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant