docs: reorganize prompt evaluation guides in navigation - #2346
Merged
anistark merged 1 commit intoOct 8, 2025
Merged
Conversation
- Move iterate_prompt.md from customizations to applications folder - Group both prompt evaluation guides under new 'Prompt Evaluation' section - Update mkdocs.yml navigation structure to reflect logical categorization - Update applications/index.md with new Prompt Evaluation section - Remove misplaced entries from customizations section Both guides are now properly categorized under Applications as they demonstrate complete end-to-end workflows rather than simple customizations.
dosubot
Bot
added
the
size:S
anistark
approved these changes
Oct 8, 2025
anistark
pushed a commit
that referenced
this pull request
Nov 17, 2025
- 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. - 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 - [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 navigation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue Link / Problem Description
iterate_prompt.mdguide was incorrectly placed under Customizations → General, when it actually demonstrates a complete application workflow for evaluating and improving prompts.Changes Made
iterate_prompt.mdfromdocs/howtos/customizations/todocs/howtos/applications/mkdocs.ymldocs/howtos/applications/index.mdwith the new Prompt Evaluation sectionmkdocs.ymlTesting
How to Test
make build-docs