Skip to content

Add cross-linking and improve documentation navigation#113

Merged
amavashev merged 2 commits intomainfrom
claude/audit-docs-blogs-L2gsm
Mar 20, 2026
Merged

Add cross-linking and improve documentation navigation#113
amavashev merged 2 commits intomainfrom
claude/audit-docs-blogs-L2gsm

Conversation

@amavashev
Copy link
Contributor

Summary

This PR enhances documentation discoverability and navigation by adding "Next steps" sections to integration guides, updating package references, and adding contextual links throughout the documentation.

Key Changes

Integration Guides

  • Added "Next steps" sections to Anthropic, OpenAI, FastAPI, and LangChain integration guides with links to related how-to guides and runnable examples
  • Each guide now links to error handling, streaming, testing, and production operations documentation

Package References

  • Updated Python client package name from cycles-client to runcycles on PyPI
  • Updated TypeScript client package name from @runcycles/client to runcycles on npm
  • Updated Spring Boot starter artifact ID from cycles-spring-boot-starter to cycles-client-java-spring

Cross-Linking

  • Added contextual "Next steps" or related links to 20+ concept, how-to, and incident pages
  • Links connect related topics (e.g., budget patterns to architectural guides, cost management to maturity models)
  • Added production-ready implementation note to agent budget patterns blog post

Blog & Content

  • Improved blog index description with more specific SEO-friendly language
  • Added navigation links in introducing-cycles blog post
  • Added incident prevention links to runaway agents incident guide

Implementation Details

  • All changes are documentation-only (Markdown files)
  • Links follow existing documentation URL patterns and structure
  • "Next steps" sections are consistently formatted across all integration guides
  • Cross-links are contextually relevant to the page content

https://claude.ai/code/session_01NEcAqmfZHsZV9WEZXNofWY

claude added 2 commits March 20, 2026 16:09
- Fix wrong package names in ecosystem.md (cycles-client → runcycles,
  @runcycles/client → runcycles, cycles-spring-boot-starter →
  cycles-client-java-spring)
- Add pseudocode disclaimer to agent-budget-patterns blog post
- Add blog cross-links to all 11 concept pages (previously zero)
- Add blog cross-links to 4 how-to guides and 4 incident pattern pages
- Add runnable SDK example links to 9 integration guides
- Improve blog index page meta description for SEO

https://claude.ai/code/session_01NEcAqmfZHsZV9WEZXNofWY
- Add error handling, streaming, testing, and production ops links to
  OpenAI, Anthropic, LangChain, and FastAPI integration guides
- Add glossary cross-link from "What is Cycles?" entry-point page
- Add docs site links to introducing-cycles-blog post

https://claude.ai/code/session_01NEcAqmfZHsZV9WEZXNofWY
@amavashev amavashev merged commit 431c7b2 into main Mar 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants