Skip to content

Commit 20b7fa0

Browse files
docs: add links to prompting guideline
Adds relevant links to the prompting guideline documentation for features like the CLI, rules, workflows, custom agents, and integrations. Also clarifies the language around sharing features to avoid confusion. 🤖 Generated with [Pochi](https://getpochi.com) Co-Authored-By: Pochi <noreply@getpochi.com>
1 parent 60f3e36 commit 20b7fa0

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

packages/docs/content/docs/prompting-guideline.mdx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Welcome to Pochi Prompting Guideline! Please consider using this doc as referenc
1717
- **Ensure Consistency:** Rely on structured prompts (XML/JSON) for repeatable, predictable outputs.
1818
- **Iterate Safely:** Tweak prompts step-by-step. Using structured formats like XML or JSON for your prompts makes it easier to track and revert changes if needed.
1919
- **Leverage Pochi Features:**
20-
- Use `~/.pochi/config.jsonc` for models & MCPs.
21-
- Use `README.pochi.md` for project-specific rules.
22-
- Use `.pochi/workflows/` for custom workflows.
23-
- Use `.pochi/agents/` for custom agents.
24-
- Use Pochi Cloud for sharing task histories.
25-
- Use the GitHub & Slack integrations for team collaboration.
20+
- Use [`~/.pochi/config.jsonc`](/cli) for models & MCPs.
21+
- Use [`README.pochi.md`](/rules) for project-specific rules.
22+
- Use [`.pochi/workflows/`](/workflows) for custom workflows.
23+
- Use [`.pochi/agents/`](/custom-agent) for custom agents.
24+
- Use [Pochi's sharing features](/share) to share task histories.
25+
- Use the [GitHub](/github) & [Slack](/slack) integrations for team collaboration.
2626

2727
## How to Prompt Pochi
2828

@@ -61,7 +61,8 @@ Apply structured formats (XML or JSON) for precision, repeatability, and task ch
6161
```xml
6262
<edit>
6363
<file>@api.js</file>
64-
<line>42</line> <context>function validateUser(input) { return input.length; } in @api.js fails with TypeError: Cannot read property 'length' of null</context>
64+
<line>42</line>
65+
<context>function validateUser(input) { return input.length; } in @api.js fails with TypeError: Cannot read property 'length' of null</context>
6566
<fix>
6667
try {
6768
if (!input) throw new TypeError('Input cannot be null');
@@ -87,7 +88,7 @@ Apply structured formats (XML or JSON) for precision, repeatability, and task ch
8788

8889
### Assign Pochi a Role (System Prompts)
8990

90-
Specify a role in the prompt or via `.pochi/agents/` to enforce standards.
91+
Specify a role in the prompt or via [`.pochi/agents/`](/custom-agent) to enforce standards.
9192

9293
**Example:**
9394
“Act as linter for `@models/db.py` per `README.pochi.md`, focusing on PEP 8 spacing issues.”
@@ -107,7 +108,7 @@ This section applies prompting patterns to common development workflows, from pr
107108

108109
- **Initiating a New Project Phase:** “Start a new phase for `@api.js`: Initialize a `/auth` module, list dependencies, document setup separately.”
109110
- **Reviewing Recent Changes:** “Review `@api.js`: Summarize last 3 commits’ impact on `/users`, flag issues.”
110-
- **Syncing Team Context:** “Sync `@utils.js` changes: Compile a summary of edits across `@api.js` and `@utils.js`, share via Pochi link, align with standards.”
111+
- **Syncing Team Context:** “Sync `@utils.js` changes: Compile a summary of edits across `@api.js` and `@utils.js`, share via [Pochi link](/share), align with standards.”
111112

112113
### Debugging
113114

0 commit comments

Comments
 (0)