Commit ef7892c
authored
docs: reorganize prompt evaluation guides in navigation (#2346)
## Issue Link / Problem Description
- Issue: The `iterate_prompt.md` guide was incorrectly placed under
Customizations β General, when it actually demonstrates a complete
application workflow for evaluating and improving prompts.
- The navigation structure didn't logically group related prompt
evaluation guides together.
## Changes Made
- Moved `iterate_prompt.md` from `docs/howtos/customizations/` to
`docs/howtos/applications/`
- Created new "Prompt Evaluation" subsection under Applications in
`mkdocs.yml`
- Grouped both prompt evaluation guides together:
- Iterate and Improve Prompts
- Systematic Prompt Optimization
- Updated `docs/howtos/applications/index.md` with the new Prompt
Evaluation section
- Removed misplaced entries from the Customizations section in
`mkdocs.yml`
- Fixed broken link (missing .md extension) for prompt_optimization in
applications/index.md
## Testing
### How to Test
- [x] Automated tests added/updated: Pre-commit hooks passed (formatting
checks)
- [x] Manual testing steps:
1. Build the documentation locally: `make build-docs`
2. Verify navigation structure shows "Prompt Evaluation" under
Applications
3. Confirm both guides are accessible and properly linked
4. Verify no broken links in the navigation1 parent 911a127 commit ef7892c
File tree
3 files changed
+10
-4
lines changed- docs/howtos/applications
3 files changed
+10
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
7 | 12 | | |
8 | 13 | | |
9 | 14 | | |
10 | 15 | | |
11 | 16 | | |
12 | 17 | | |
13 | | - | |
14 | 18 | | |
15 | | - | |
| 19 | + | |
16 | 20 | | |
17 | 21 | | |
18 | 22 | | |
19 | 23 | | |
| 24 | + | |
20 | 25 | | |
21 | 26 | | |
22 | 27 | | |
| |||
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
99 | 98 | | |
100 | 99 | | |
101 | 100 | | |
102 | 101 | | |
103 | 102 | | |
104 | 103 | | |
105 | | - | |
106 | 104 | | |
107 | 105 | | |
108 | 106 | | |
| |||
111 | 109 | | |
112 | 110 | | |
113 | 111 | | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
114 | 115 | | |
115 | 116 | | |
116 | 117 | | |
| |||
0 commit comments