Skip to content

Commit 889e6ab

Browse files
authored
Merge pull request #7579 from continuedev/feat/continuous-ai-guide
feat: add continuous ai readiness guide
2 parents 5512dd6 + 7b28e1c commit 889e6ab

File tree

4 files changed

+323
-4
lines changed

4 files changed

+323
-4
lines changed

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,7 @@
233233
"guides/codebase-documentation-awareness",
234234
"guides/cli",
235235
"guides/continuous-ai",
236+
"guides/continuous-ai-readiness-assessment",
236237
"guides/plan-mode-guide",
237238
"guides/ollama-guide",
238239
"guides/instinct",

docs/guides/codebase-documentation-awareness.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: How to make your agent aware of codebases and documentation
2+
title: How to Make Your Agent Aware of Codebases and Documentation
33
description: Learn how to give your AI agent access to codebases and documentation for more context-aware assistance
44
keywords: [agent, codebase, documentation, MCP, context, RAG, tools]
5+
sidebarTitle: Codebase and Documentation Awareness
56
---
67

7-
# How to make your agent aware of codebases and documentation
8-
98
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.
109

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

3029
This is a React application with:
30+
3131
- Components in `/src/components`
3232
- API routes in `/src/api`
3333
- State management using Redux in `/src/store`
3434

3535
## Coding Standards
36+
3637
- Use TypeScript for all new files
3738
- Follow the existing naming conventions
3839
- Write tests for all new features
3940
```
4041

4142
<Tip>
42-
Place rules files at different levels of your project hierarchy to scope when they trigger
43+
Place rules files at different levels of your project hierarchy to scope when
44+
they trigger
4345
</Tip>
4446

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

6264
Our authentication system is based on:
65+
6366
- [Auth.js documentation](https://authjs.dev/)
6467
- [Example implementation](https://github.com/nextauthjs/next-auth-example)
6568

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

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

8892
Once configured, your agent can explore repositories like:
93+
8994
- "Explore the React repository structure"
9095
- "Find how authentication is implemented in NextAuth.js"
9196

@@ -115,6 +120,7 @@ Guide your agent to relevant documentation:
115120
# Documentation Resources
116121

117122
For framework-specific questions, refer to:
123+
118124
- React: https://react.dev/reference/react
119125
- Next.js: https://nextjs.org/docs
120126
- Tailwind CSS: https://tailwindcss.com/docs
@@ -127,6 +133,7 @@ Always cite documentation when explaining concepts.
127133
[Context7 MCP](https://hub.continue.dev/upstash/context7-mcp) enables your agent to search and retrieve information from public documentation:
128134

129135
Your agent can then answer questions like:
136+
130137
- "How do I use React hooks?"
131138
- "What's the syntax for Tailwind CSS animations?"
132139

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

144151
Our team documentation is available at:
152+
145153
- API Documentation: https://internal.docs/api
146154
- Architecture Guide: https://internal.docs/architecture
147155
- Deployment Process: https://internal.docs/deployment

0 commit comments

Comments
 (0)