Skip to content

Add comprehensive concept documentation for ra#149

Merged
chinmaymk merged 3 commits intomainfrom
claude/add-ra-concepts-docs-suqqH
Mar 23, 2026
Merged

Add comprehensive concept documentation for ra#149
chinmaymk merged 3 commits intomainfrom
claude/add-ra-concepts-docs-suqqH

Conversation

@chinmaymk
Copy link
Copy Markdown
Owner

Summary

This PR adds a complete set of concept documentation pages that explain the core ideas and components of ra. These pages serve as the conceptual foundation for users to understand how ra works before diving into detailed references.

Key Changes

  • Added 7 new concept documentation pages:

    • agent-loop.md — Explains the core agent loop cycle, middleware hooks, and configuration options
    • providers.md — Documents available LLM providers, switching between them, and credential management
    • tools.md — Describes built-in tools, MCP integration, permissions, and tool execution flow
    • middleware.md — Covers the middleware system, all 9 hooks, and how to write custom middleware
    • skills.md — Explains skill structure, activation, scripts, references, and skill directories
    • recipes.md — Documents recipe packaging, installation, config layering, and built-in recipes
    • configuration.md — Details the layered config system, environment variable interpolation, and minimal/full config examples
    • sessions.md — Covers session persistence, resuming, scoping, auto-pruning, and the memory system
  • Updated navigation structure:

    • Reorganized sidebar to separate "Concepts" (new) from "Core" sections
    • Added all 8 new concept pages to the Concepts navigation menu
    • Moved "The Agent Loop" reference to Core section (keeping concept version in Concepts)
  • Added onboarding link:

    • Added a "New to ra? Start with Concepts" link to the homepage to guide new users

Implementation Details

  • All documentation follows consistent structure with clear headings, code examples, and tables
  • Concept pages focus on "what" and "why" rather than exhaustive API details
  • Cross-references between pages use relative links (e.g., /concepts/agent-loop)
  • Examples use realistic YAML configurations and TypeScript code
  • Each page includes a reference link to more detailed documentation where applicable

https://claude.ai/code/session_01Wkd4XjYwEGSCNwzcfkthDJ

claude added 3 commits March 23, 2026 14:28
Introduce six new concept pages that ease readers into ra's building
blocks: agent loop, providers, tools, middleware, skills, and recipes.
Each page explains the mental model and links to the detailed reference.
The sidebar now has a standalone Concepts section before Core.

https://claude.ai/code/session_01Wkd4XjYwEGSCNwzcfkthDJ
Add two more concept pages covering the layered config system and
session persistence/memory. Update the landing page with a link to
the concepts section for newcomers.

https://claude.ai/code/session_01Wkd4XjYwEGSCNwzcfkthDJ
@chinmaymk chinmaymk merged commit d9bd7c4 into main Mar 23, 2026
2 checks passed
@chinmaymk chinmaymk deleted the claude/add-ra-concepts-docs-suqqH branch March 23, 2026 15:47
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