Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@
"guides/codebase-documentation-awareness",
"guides/cli",
"guides/continuous-ai",
"guides/continuous-ai-readiness-assessment",
"guides/plan-mode-guide",
"guides/ollama-guide",
"guides/instinct",
Expand Down
16 changes: 12 additions & 4 deletions docs/guides/codebase-documentation-awareness.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: How to make your agent aware of codebases and documentation
title: How to Make Your Agent Aware of Codebases and Documentation
description: Learn how to give your AI agent access to codebases and documentation for more context-aware assistance
keywords: [agent, codebase, documentation, MCP, context, RAG, tools]
sidebarTitle: Codebase and Documentation Awareness
---

# How to make your agent aware of codebases and documentation

AI coding agents work best when they understand the context of your project. This guide shows you how to give your agent access to codebases and documentation, making it more helpful and accurate.

## Make your agent aware of your open codebase
Expand All @@ -28,18 +27,21 @@ Rules guide your agent's behavior and understanding. Place markdown files in `.c
# Project Architecture

This is a React application with:

- Components in `/src/components`
- API routes in `/src/api`
- State management using Redux in `/src/store`

## Coding Standards

- Use TypeScript for all new files
- Follow the existing naming conventions
- Write tests for all new features
```

<Tip>
Place rules files at different levels of your project hierarchy to scope when they trigger
Place rules files at different levels of your project hierarchy to scope when
they trigger
</Tip>

Learn more about [rules configuration](/customize/deep-dives/rules).
Expand All @@ -60,6 +62,7 @@ Create rules that point to external codebases:
# External Dependencies

Our authentication system is based on:

- [Auth.js documentation](https://authjs.dev/)
- [Example implementation](https://github.com/nextauthjs/next-auth-example)

Expand All @@ -76,6 +79,7 @@ Add rules to guide CLI usage:
# Repository Access

You can use the `gh` CLI to:

- Search for issues: `gh issue list --repo owner/repo`
- View pull requests: `gh pr list --repo owner/repo`
- Clone repositories: `gh repo clone owner/repo`
Expand All @@ -86,6 +90,7 @@ You can use the `gh` CLI to:
[DeepWiki MCP](https://hub.continue.dev/deepwiki/deepwiki-mcp) lets your agent explore any public GitHub repository.

Once configured, your agent can explore repositories like:

- "Explore the React repository structure"
- "Find how authentication is implemented in NextAuth.js"

Expand Down Expand Up @@ -115,6 +120,7 @@ Guide your agent to relevant documentation:
# Documentation Resources

For framework-specific questions, refer to:

- React: https://react.dev/reference/react
- Next.js: https://nextjs.org/docs
- Tailwind CSS: https://tailwindcss.com/docs
Expand All @@ -127,6 +133,7 @@ Always cite documentation when explaining concepts.
[Context7 MCP](https://hub.continue.dev/upstash/context7-mcp) enables your agent to search and retrieve information from public documentation:

Your agent can then answer questions like:

- "How do I use React hooks?"
- "What's the syntax for Tailwind CSS animations?"

Expand All @@ -142,6 +149,7 @@ Create rules that reference internal resources:
# Internal Documentation

Our team documentation is available at:

- API Documentation: https://internal.docs/api
- Architecture Guide: https://internal.docs/architecture
- Deployment Process: https://internal.docs/deployment
Expand Down
Loading
Loading