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

Document Code Source links #505

Merged
merged 7 commits into from
Oct 18, 2024
Merged

Document Code Source links #505

merged 7 commits into from
Oct 18, 2024

Conversation

Kludex
Copy link
Member

@Kludex Kludex commented Oct 16, 2024

If it's easier, please apply the changes that you wish. I'm okay with anything. 🙏

Copy link

cloudflare-workers-and-pages bot commented Oct 16, 2024

Deploying logfire-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1afb4b9
Status: ✅  Deploy successful!
Preview URL: https://47bb9ac8.logfire-docs.pages.dev
Branch Preview URL: https://document-code-source-links.logfire-docs.pages.dev

View logs

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0428370) to head (1afb4b9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #505   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          132       132           
  Lines         9986      9986           
  Branches      1343      1343           
=========================================
  Hits          9986      9986           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sydney-runkle
Copy link
Member

There's a related issue to this right? Can we link it as closing #79?

Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool feature! Left some ideas for changes and questions.

docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
code_source=logfire.CodeSource(
repository='https://github.com/pydantic/logfire',
revision='main',
root_path='.',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this just be the default?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can change this in a future PR, but I guess it makes sense to be the default yes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like it should be optional in the data class but the frontend needs to handle defaulting to it so that the env var isn't required

Copy link
Member Author

@Kludex Kludex Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The frontend already handles it, defaulting to it.

docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
docs/guides/advanced/link-to-code-source.md Outdated Show resolved Hide resolved
Kludex and others added 3 commits October 18, 2024 13:03
Co-authored-by: Sydney Runkle <54324534+sydney-runkle@users.noreply.github.com>
@Kludex Kludex force-pushed the document-code-source-links branch from d8d2d9f to ed45090 Compare October 18, 2024 12:04
Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@Kludex Kludex enabled auto-merge (squash) October 18, 2024 12:55
@Kludex Kludex merged commit fa559ad into main Oct 18, 2024
13 checks passed
@Kludex Kludex deleted the document-code-source-links branch October 18, 2024 13:26
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.

4 participants