docs: add Quickstart page + surface FastMCP in nav#134
Merged
Conversation
End-to-end FastAPI walkthrough (install, bootstrap, run, what-you-get, enabling more instruments). Also adds the existing FastMCP integration page to the nav, where it was previously unreachable. 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.
Closes the two real doc gaps from the promotion-readiness review.
Added
introduction/quickstart.md— an end-to-end FastAPI walkthrough: install → bootstrap → run → what you get → enabling more instruments (OTel/Sentry/Pyroscope) → inspectingskipped_instruments/build_summary(). Content verified againstintroduction/configuration.md(e.g.health_checks_enabled=Truerequired; structlog on by default).Fixed
integrations/fastmcp.md) existed in the repo but was missing from the nav — now reachable.Verified:
mkdocs build --strictpasses; the new Quickstart introduces no link warnings.Note (optional follow-up, out of scope here): the build's INFO log shows several pre-existing unrecognized relative links in
index.mdand the integration pages (e.g.../../../introduction/installation). They render via directory-URLs but aren't mkdocs-validatable; happy to clean them up in a separate PR.