You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: packages/docs/content/docs/prompting-guideline.mdx
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,12 @@ Welcome to Pochi Prompting Guideline! Please consider using this doc as referenc
17
17
-**Ensure Consistency:** Rely on structured prompts (XML/JSON) for repeatable, predictable outputs.
18
18
-**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.
19
19
-**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.
26
26
27
27
## How to Prompt Pochi
28
28
@@ -61,7 +61,8 @@ Apply structured formats (XML or JSON) for precision, repeatability, and task ch
61
61
```xml
62
62
<edit>
63
63
<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>
65
66
<fix>
66
67
try {
67
68
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
87
88
88
89
### Assign Pochi a Role (System Prompts)
89
90
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.
91
92
92
93
**Example:**
93
94
“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
107
108
108
109
-**Initiating a New Project Phase:** “Start a new phase for `@api.js`: Initialize a `/auth` module, list dependencies, document setup separately.”
109
110
-**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.”
0 commit comments