Skip to content

Commit 94c8ea6

Browse files
Kasper Jungeclaude
authored andcommitted
docs: group nav into sections and fix placeholder troubleshooting for users who need to navigate docs or debug missing content
Reorganize the flat 9-page nav into Guide/Reference/Help sections with navigation.sections enabled for clear sidebar grouping. Fix the troubleshooting page's incorrect claim that unresolved placeholders appear as raw text — the code replaces unmatched names with empty string, so the real symptom is silently missing content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent db7b8f7 commit 94c8ea6

2 files changed

Lines changed: 19 additions & 10 deletions

File tree

docs/troubleshooting.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,16 +142,20 @@ If `ralph status` warns that a check has neither a `run.*` script nor a `command
142142

143143
## Context and instruction issues
144144

145-
### Placeholders not resolving
145+
### Placeholder produces no output
146146

147-
If you see raw `{{ contexts.my-context }}` text in the agent's output, the placeholder name doesn't match any discovered context. Check:
147+
If a `{{ contexts.my-context }}` placeholder silently disappears (the prompt has nothing where you expected content), the context name doesn't match any discovered context. Ralphify replaces unmatched named placeholders with an empty string — you won't see raw placeholder text. Check:
148148

149149
1. The directory name matches: `.ralph/contexts/my-context/CONTEXT.md`
150150
2. The placeholder uses the exact directory name: `{{ contexts.my-context }}`
151151
3. The context is enabled (check with `ralph status`)
152+
4. If the context has a command, verify the command produces output by running it manually
152153

153154
Same rules apply for `{{ instructions.name }}`.
154155

156+
!!! note "Raw placeholder text still visible?"
157+
If you see literal `{{ contexts.name }}` in the agent's output, the placeholder syntax wasn't recognized — usually a typo in the keyword (e.g. `{{ context.name }}` instead of `{{ contexts.name }}`). It must be `contexts` (plural) and `instructions` (plural).
158+
155159
### Context command failing
156160

157161
Run the context command manually:

mkdocs.yml

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ theme:
2626
features:
2727
- content.code.copy
2828
- content.code.annotate
29+
- content.tabs.link
2930
- navigation.instant
3031
- navigation.tracking
32+
- navigation.sections
3133
- navigation.top
3234
- navigation.footer
3335
- search.suggest
@@ -60,11 +62,14 @@ extra:
6062

6163
nav:
6264
- Home: index.md
63-
- Getting Started: getting-started.md
64-
- How It Works: how-it-works.md
65-
- Writing Your Prompt: prompts.md
66-
- Cookbook: cookbook.md
67-
- Primitives: primitives.md
68-
- Configuration & CLI: cli.md
69-
- FAQ: faq.md
70-
- Troubleshooting: troubleshooting.md
65+
- Guide:
66+
- Getting Started: getting-started.md
67+
- How It Works: how-it-works.md
68+
- Writing Your Prompt: prompts.md
69+
- Cookbook: cookbook.md
70+
- Reference:
71+
- Primitives: primitives.md
72+
- Configuration & CLI: cli.md
73+
- Help:
74+
- FAQ: faq.md
75+
- Troubleshooting: troubleshooting.md

0 commit comments

Comments
 (0)