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

docs: add example notebook for the JS SDK #1067

Merged
merged 17 commits into from
Dec 4, 2024
Merged

docs: add example notebook for the JS SDK #1067

merged 17 commits into from
Dec 4, 2024

Conversation

jannikmaierhoefer
Copy link
Collaborator

@jannikmaierhoefer jannikmaierhoefer commented Dec 3, 2024

Important

Adds a new example notebook for the JS SDK, updates routing and metadata, and provides a detailed guide in example-notebook.md.

  • New Example Notebook:
    • Adds js_langfuse_sdk.ipynb to cookbook/_routes.json with docsPath set to docs/sdk/typescript/example-notebook.
    • Creates example-notebook.md in pages/docs/sdk/typescript/ with a detailed guide on using the Langfuse JS/TS SDK.
  • Routing and Metadata:
    • Updates cookbook/_routes.json to include the new notebook.
    • Updates pages/docs/sdk/typescript/_meta.tsx to add "Example Notebook" entry.
  • Misc:
    • Adds get-started-js-sdk.mdx to components-mdx/ for JS SDK setup.
    • Updates pages/docs/get-started.mdx to include a link to the new example notebook.
    • Minor text changes in pages/docs/sdk/python/decorators.mdx to reference the new notebook.

This description was created by Ellipsis for 63ca4f4. It will automatically update as commits are pushed.

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Dec 3, 2024
Copy link

vercel bot commented Dec 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
langfuse-docs ✅ Ready (Inspect) Visit Preview Dec 4, 2024 0:36am

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@dosubot dosubot bot added the documentation Improvements or additions to documentation label Dec 3, 2024
Copy link

github-actions bot commented Dec 3, 2024

📦 Next.js Bundle Analysis for langfuse-docs

This analysis was generated by the Next.js Bundle Analysis action. 🤖

New Pages Added

The following pages were added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/changelog/2024-12-04-extensive-end-to-end-example-for-js-ts 29.61 KB 362.22 KB 103.49%
/docs/sdk/typescript/example-notebook 32.44 KB 365.06 KB 104.30%
/guides/cookbook/js_langfuse_sdk 32.46 KB 365.07 KB 104.31%

Two Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/docs/get-started 38.5 KB 371.12 KB 106.03% (🟡 +0.18%)
/docs/sdk/typescript/guide 39 KB 371.62 KB 106.18% (🟡 +0.32%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

@marcklingen marcklingen changed the title Docs: Add example notebook for the JS SDK docs: Add example notebook for the JS SDK Dec 3, 2024
@marcklingen marcklingen changed the title docs: Add example notebook for the JS SDK docs: add example notebook for the JS SDK Dec 3, 2024
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Dec 4, 2024
Copy link
Member

@marcklingen marcklingen left a comment

Choose a reason for hiding this comment

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

made some copy changes and added changelog post, merging now

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 4, 2024
@marcklingen marcklingen enabled auto-merge December 4, 2024 00:26
@marcklingen marcklingen added this pull request to the merge queue Dec 4, 2024
Merged via the queue into main with commit 9f45c1f Dec 4, 2024
7 of 8 checks passed
@marcklingen marcklingen deleted the js-sdk branch December 4, 2024 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants