docs: add Why fastapi-startkit page and sharpen home hero#62
Open
tmgbedu wants to merge 1 commit into
Open
Conversation
Rewrite the home hero tagline into a batteries-included-for-FastAPI value prop and add a secondary CTA to the new positioning page. Add docs/why.md covering what FastAPI leaves to you, the provider model (bare class and (Provider, Config) tuple), the FastAPI-optional/headless angle, and the not-a-replacement framing. Register the page at the top of the Guide sidebar.
tmgbedu
commented
Jul 8, 2026
tmgbedu
left a comment
Contributor
Author
There was a problem hiding this comment.
✅ APPROVE (posted as comment — GitHub blocks self-approval on own PR)
Reviewed the full diff, verified the provider snippet against the source of truth, and ran a clean npm run docs:build. Everything checks out.
Verified
- Hero tagline (
index.md) — accurate batteries-included value prop; the listed concerns (ORM, migrations, config, logging, CLI, providers) all ship in the framework. - CTAs — Get Started →
/docs/getting-started, Why fastapi-startkit? →/docs/why; both render in built output. - Provider snippet (
docs/why.md) — byte-for-byte matchesexample/fastapi-app/bootstrap/application.py: bare-classLogProvider+(FastAPIProvider, FastAPIConfig)tuple, correctly explained. - FastAPI-optional / headless angle — present and accurate.
- Not-a-replacement framing — present; correctly notes
app.fastapiis a real FastAPI app. - Next → Getting Started pointer — present.
- Sidebar (
.vitepress/config.mts) — registered at the top of the Guide group, above Getting Started. - Build —
npm run docs:buildpasses with no dead-link failures;#installationanchor resolves;/docs/whyand/render correctly.
No blocking issues. Not merging per instructions.
(Nit, non-blocking: snippet comment uses two spaces before # vs one in source — cosmetic only.)
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.
Summary
Positions fastapi-startkit for newcomers landing on the docs.
Changes
index.md— rewrote the vague hero tagline ("The components needs to build a great Python application.") into a crisp batteries-included-for-FastAPI value prop, and added a secondaryaltCTA linking to the new Why fastapi-startkit? page (primary CTA renamed to Get Started).docs/why.md— new positioning page covering:LogProvider) and a(Provider, Config)tuple ((FastAPIProvider, FastAPIConfig)), lifted fromexample/fastapi-app/bootstrap/application.py.vitepress/config.mts— registered the page at the top of the Guide sidebar.Verification
npm run docs:buildcompletes cleanly (VitePress fails on dead links; the new/docs/whylink and the/docs/getting-started#installationanchor both resolve).vitepress devserves/docs/whyand/with HTTP 200.