-
Notifications
You must be signed in to change notification settings - Fork 66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add how to guide section #618
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The style guide flagged several spelling errors that seemed like false positives. We skipped posting inline suggestions for the following words:
- pytest
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #618 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 133 133
Lines 10567 10567
Branches 1450 1450
=========================================
Hits 10567 10567 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
That's a thing I don't like about our docs and FastAPI ones: pages describing what you have in other pages. It adds a lot of burden, since we forget about those pages. |
Deploying logfire-docs with Cloudflare Pages
|
As discussed, this is based on analysis of a lot of customer queries in the public slack, where people have struggled to find things in the docs. I agree that it does add some maintenance burden, but I think the trade-off in usability will be worth it. |
Inspired by: https://fastapi.tiangolo.com/how-to/general/
https://linear.app/pydantic/issue/PYD-1363/create-index-or-general-how-to-guide-page