Skip to content
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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a 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

Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (72ceb6b) to head (fd10dba).

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.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@Kludex
Copy link
Member

Kludex commented Nov 21, 2024

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.

Copy link

cloudflare-workers-and-pages bot commented Nov 21, 2024

Deploying logfire-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fd10dba
Status: ✅  Deploy successful!
Preview URL: https://91488d53.logfire-docs.pages.dev
Branch Preview URL: https://cs-docs-add-how-to-index.logfire-docs.pages.dev

View logs

@ChristopherGS
Copy link
Contributor Author

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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants