Repository navigation
docs(dspy): fix the optimizers overview link on the BetterTogether page - #10253
Merged
isaacbmiller merged 2 commits intoAug 21, 2026
Merged
isaacbmiller merged 2 commits into
isaacbmiller merged 2 commits into
Conversation
The "Further Reading" link pointed at ../../../learn/programming/optimizers.md, which is wrong twice over: the optimizers overview lives under learn/optimization/, not learn/programming/, and from docs/api/optimizers/ the three-level prefix climbs above the docs root. mkdocs left the href untouched in the rendered page, so the link 404s for readers. Point it at ../../learn/optimization/optimizers.md, matching the two-level form already used in api/utils/configure.md and api/utils/context.md.
Contributor
Greptile SummaryThe BetterTogether Further Reading link now uses the matching “Optimizers: choosing one” label and opens the live optimizer-selection guide. Rendered-browser validation confirmed that it no longer lands on the GEPA getting-started tutorial. Confidence Score: 5/5No blocking failure remains. The rendered link and its destination were exercised successfully, and no accepted blocking findings remain.
What T-Rex did
Reviews (2): Last reviewed commit: "docs(dspy): point the further-reading li..." | Re-trigger Greptile |
The first pass only fixed the path, so the link resolved but landed on a redirect stub: mkdocs.yml maps learn/optimization/optimizers.md to getting-started/gepa-optimization.md, and the whole learn/ tree redirects into getting-started/. A reader clicking "DSPy Optimizers Overview" ended up in the GEPA tutorial instead of an overview. Link diving-deeper/choosing-an-optimizer.md instead, which is live in the nav, carries no redirect, and covers what each optimizer tunes and how to pick one. The label now repeats that page's own title so the two cannot drift apart again.
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
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.
📝 Changes Description
The "Further Reading" list at the bottom of the BetterTogether page pointed at
../../../learn/programming/optimizers.md. That path is wrong twice over. The optimizers overview lives underlearn/optimization/, notlearn/programming/, and fromdocs/api/optimizers/a three-level prefix climbs above the docs root.mkdocs leaves a relative link alone when it cannot resolve it, so the bad href goes straight into the built page. Building current main reports it:
and the generated HTML keeps it verbatim, so the link 404s for anyone who clicks it:
This changes the target to
../../learn/optimization/optimizers.md, the same two-level form already used byapi/utils/configure.mdandapi/utils/context.md. The link text stays as it was.It is the only occurrence.
grep -rn "learn/programming/optimizers" docs/finds nothing else.Validation, running what
docs-push.ymlruns (pip install -r requirements.txtthenmkdocs build), before and after the change:The total drops by two rather than one because a second warning, a Discord badge request coming back 403, showed up only in the first run and has nothing to do with this change.
✅ Contributor Checklist
Two things worth flagging.
No pre-commit hook covers markdown.
ruffis scoped to^(dspy|tests)/.*\.py$and the rest of the hooks handle yaml, toml, large files, and merge markers, so the checklist item above is true but close to vacuous for this diff. The real check here was the docs build.docs-push.ymlruns a baremkdocs buildwithout--strict, which is why a broken link never failed CI. I left that alone on purpose. With 245 warnings still on main, most of them griffe complaining about docstring indentation, turning on strict mode would block the build immediately, and that is a maintainer decision rather than something to fold into a one-line docs fix.