docs: fix broken home-page list, dead links, and typos#146
Merged
Conversation
The intro list on the home page rendered as a run-together paragraph
because python-markdown requires a blank line before a list; add it.
Repoint the home-page integration links and every integration page's
"Read more" links to correct `.md`-relative targets (the old
`../../../introduction/...` paths were the wrong depth, missing `.md`,
and only worked via a host redirect). Fix typos ("build you" ->
"build your", "choosen" -> "chosen", "Fastapi" -> "FastAPI") and
document the missing `prometheus_group_path` Litestar config field.
Mirror the blank-line fix in README for parity.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Audit and fix of the docs site (https://lite-bootstrap.modern-python.org/) triggered by the broken list on the home page.
README.md's identical list only looked fine because GitHub's markdown is more lenient; mirrored the fix there for parity.)../../../introduction/...— wrong depth (two extra../, clamped at site root), missing.md, dangling trailing colon. They only worked via a host redirect. Repointed to../introduction/installation.md/../introduction/configuration.md. Also fixed the home-page integration links to use.mdtargets.build you application->build your application(4 pages),choosen extras->chosen extras,`Fastapi`->`FastAPI`heading.prometheus_group_pathfield in the Prometheus/Litestar config reference.Verification
uv run mkdocs build --strictpasses with no link/render warnings.site/index.htmlnow emits a real<ul>for the intro list.pyproject.tomland the source — all accurate; no code changes needed.🤖 Generated with Claude Code