Skip to content

Commit 7852bdc

Browse files
committed
Backlinks!
Signed-off-by: teocns <teocns@gmail.com>
1 parent 6ecc76d commit 7852bdc

12 files changed

Lines changed: 53 additions & 8 deletions

‎docs/agents/creating-agents.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: "How to create agents: frontmatter fields, system prompt design, mo
44
sidebar_position: 2
55
---
66

7+
:::tip[Official reference]
8+
For how sub-agents work in Claude Code, see the [official sub-agents docs](https://code.claude.com/docs/en/sub-agents).
9+
:::
10+
711
## File Location
812

913
Place agent files in the `agents/` directory of your plugin:

‎docs/index.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ hero:
1515
variant: minimal
1616
---
1717

18-
import { LinkCard, CardGrid } from '@astrojs/starlight/components';
18+
import { LinkCard, CardGrid, Aside } from '@astrojs/starlight/components';
19+
20+
<Aside type="tip">
21+
New to Claude Code? Start with the [official quickstart](https://code.claude.com/docs/en/quickstart) to get installed and running. This guide picks up where that leaves off.
22+
</Aside>
1923

2024
<CardGrid>
2125
<LinkCard

‎docs/patterns/agentic-engineering.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,4 @@ The agent doesn't know what it doesn't know. Your job is to fill the gaps with c
8383

8484
- [Workflow patterns](workflow-patterns.md) — concrete patterns for common tasks
8585
- [Common pitfalls](../reference/common-pitfalls.md) — mistakes to avoid
86+
- [Official best practices](https://code.claude.com/docs/en/best-practices) — Anthropic's own recommendations

‎docs/patterns/context-management.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: "How to keep Claude Code effective across long sessions and large c
44
sidebar_position: 3
55
---
66

7+
:::tip[Official reference]
8+
For CLAUDE.md mechanics and memory configuration, see the [official memory docs](https://code.claude.com/docs/en/memory). For all configuration options, see [settings](https://code.claude.com/docs/en/settings).
9+
:::
10+
711
How to keep Claude Code effective across long sessions and large codebases.
812

913
## The Context Window

‎docs/patterns/workflow-patterns.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,7 @@ When you're new to a codebase or unfamiliar module.
7878
- **Review diffs, not just the outcome.** Claude may change more than necessary — check what actually changed.
7979
- **Use `/compact` between tasks.** Frees context for the next piece of work.
8080
- **Don't fight the agent.** If Claude is going in circles, step back and reframe the task rather than repeating the same instruction.
81+
82+
:::tip[Want more?]
83+
The official docs have a broader set of [common workflows](https://code.claude.com/docs/en/common-workflows) covering PR creation, CI integration, and more.
84+
:::

‎docs/reference/common-pitfalls.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,6 @@ Mistakes engineers make when starting with Claude Code — and how to avoid them
6262

6363
**The fix:** One task at a time. Commit between tasks. Each change should be reviewable on its own.
6464

65+
## Keep Learning
66+
67+
For more on working effectively with Claude Code, see the [official best practices](https://code.claude.com/docs/en/best-practices).

‎docs/reference/links.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,19 @@ Curated links for engineers using Claude Code. We cover the advanced setup and p
88

99
## Official Documentation
1010

11-
- [Claude Code Documentation](https://code.claude.com/docs) — Start here for installation, settings reference, and getting started
12-
- [Claude Code Docs (Anthropic)](https://docs.anthropic.com/en/docs/claude-code/overview) — Anthropic's reference docs
11+
This guide covers the opinionated setup. The official docs cover everything else.
12+
13+
- [Claude Code Documentation](https://code.claude.com/docs) — The starting point for everything
14+
- [Quickstart](https://code.claude.com/docs/en/quickstart) — Installation and first session
15+
- [Settings Reference](https://code.claude.com/docs/en/settings) — All configuration options
16+
- [Hooks](https://code.claude.com/docs/en/hooks) — Full hooks API and event types
17+
- [MCP](https://code.claude.com/docs/en/mcp) — Model Context Protocol reference
18+
- [Skills](https://code.claude.com/docs/en/skills) — How skills work under the hood
19+
- [Sub-agents](https://code.claude.com/docs/en/sub-agents) — Agent spawning and management
20+
- [Best Practices](https://code.claude.com/docs/en/best-practices) — Anthropic's recommendations
21+
- [CLI Reference](https://code.claude.com/docs/en/cli-reference) — All CLI commands and flags
1322
- [Claude Code GitHub](https://github.com/anthropics/claude-code) — Source, issues, and discussions
14-
- [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) — The protocol for connecting Claude to external tools
23+
- [Model Context Protocol](https://modelcontextprotocol.io/) — The MCP specification
1524
- [Anthropic Cookbook](https://github.com/anthropics/anthropic-cookbook) — Practical examples and patterns
1625

1726
## Skills Ecosystem

‎docs/setup/claude-md.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ description: "How to write effective CLAUDE.md files — the highest-leverage co
44
sidebar_position: 1
55
---
66

7+
:::tip[New to CLAUDE.md?]
8+
Start with the [official CLAUDE.md guide](https://code.claude.com/docs/en/memory) for the basics. This page is the opinionated blueprint for making yours great.
9+
:::
10+
711
CLAUDE.md is the highest-leverage configuration surface for Claude Code. It's loaded into every conversation, so every line must earn its place.
812

913
## What CLAUDE.md Does

‎docs/setup/hooks-playbook.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ description: "Essential hooks every project should have — enforcing what CLAUD
44
sidebar_position: 3
55
---
66

7-
CLAUDE.md is advisory — Claude follows it because it's in context, but nothing enforces compliance. Hooks are code. They execute automatically on specific events and can block, modify, or extend Claude's behavior.
7+
Here's the thing about CLAUDE.md: it's a suggestion. Claude *usually* follows it, but nothing enforces compliance. Hooks are different. Hooks are code — they execute automatically on specific events and can block, modify, or extend Claude's behavior. If CLAUDE.md is a polite request, hooks are a locked door.
88

9-
For the full hooks reference, see the [official docs](https://code.claude.com/docs/hooks).
9+
:::tip[Official reference]
10+
For the full hooks API, event types, and configuration options, see the [official hooks docs](https://code.claude.com/docs/en/hooks). This page gives you the five hooks worth setting up first.
11+
:::
1012

1113
## The Essential Five
1214

‎docs/setup/mcp-wiring.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ description: "Connect Claude Code to your external tools — GitHub, databases,
44
sidebar_position: 4
55
---
66

7-
MCP (Model Context Protocol) connects Claude Code to external tools and data sources. Instead of copy-pasting context from GitHub issues, database queries, or Jira tickets, Claude can access them directly.
7+
This is where Claude Code goes from "smart editor" to "team member with access." MCP (Model Context Protocol) connects Claude to your external tools and data sources — GitHub, databases, project management, Slack, and more. No more copy-pasting context. Claude reads the issue, queries the schema, writes the code, and opens the PR.
88

9-
For the full MCP reference, see the [official docs](https://code.claude.com/docs/mcp).
9+
:::tip[Official reference]
10+
For the full MCP API, authentication flows, and server registry, see the [official MCP docs](https://code.claude.com/docs/en/mcp). This page covers the three connections worth setting up first.
11+
:::
1012

1113
## The Three Most Impactful Connections
1214

0 commit comments

Comments
 (0)