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

more doc link fixes #1133

Merged
merged 1 commit into from
Nov 1, 2024
Merged

more doc link fixes #1133

merged 1 commit into from
Nov 1, 2024

Conversation

aaronvg
Copy link
Contributor

@aaronvg aaronvg commented Nov 1, 2024

Important

Fixes documentation links, updates Next.js configuration, and adds changelog entries.

  • Documentation Links:
    • Fixed links in hallucinations.mdx for chain-of-thought and symbol tuning.
    • Updated link in what-is-baml_src.mdx for Deploying.
  • Configuration:
    • Added next.config.mjs configuration for @boundaryml/baml in nextjs.mdx.
  • Styles:
    • Added background color for .prose code in styles.css.
  • Navigation:
    • Updated docs.yml to reflect changes in documentation structure.
  • Changelog:
    • Added entries for versions 0.65.0, 0.64.0, and 0.63.0 in changelog.mdx.

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

Copy link

vercel bot commented Nov 1, 2024

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

Name Status Preview Comments Updated (UTC)
baml ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 1, 2024 11:42pm

@aaronvg aaronvg enabled auto-merge November 1, 2024 23:39
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to 3f59d3a in 1 minute and 7 seconds

More details
  • Looked at 189 lines of code in 7 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 drafted comments based on config settings.
1. fern/pages/welcome.mdx:47
  • Draft comment:
    Ensure that the updated link /ref is consistent with the intended path for the reference section. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR changes a link in the welcome page to a more concise path. This change should be consistent across the codebase.
2. fern/01-guide/06-prompt-engineering/hallucinations.mdx:31
  • Draft comment:
    Ensure that the updated link /examples/prompt-engineering/chain-of-thought is consistent with the intended path for the chain-of-thought guide. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR updates links in the hallucinations.mdx file to point to the examples directory. This change should be consistent across the codebase.
3. fern/01-guide/06-prompt-engineering/hallucinations.mdx:35
  • Draft comment:
    Ensure that the updated link /examples/prompt-engineering/symbol-tuning is consistent with the intended path for the symbol tuning guide. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR updates links in the hallucinations.mdx file to point to the examples directory. This change should be consistent across the codebase.
4. fern/01-guide/what-is-baml_src.mdx:16
  • Draft comment:
    Ensure that the updated link /guide/development/deploying/aws is consistent with the intended path for the deploying guide. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR updates a link in the what-is-baml_src.mdx file to point to a new path. This change should be consistent across the codebase.
5. fern/docs.yml:379
  • Draft comment:
    Ensure that the updated page title "Google AI: Gemini" and path /03-reference/baml/clients/providers/google-ai.mdx are consistent with the intended documentation structure. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR updates the navigation structure in the docs.yml file. Ensure that the changes are consistent with the intended documentation structure.
6. fern/docs.yml:381
  • Draft comment:
    Ensure that the updated page title "Google: Vertex" and path /03-reference/baml/clients/providers/vertex.mdx are consistent with the intended documentation structure. Verify that this change aligns with the overall documentation structure.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR updates the navigation structure in the docs.yml file. Ensure that the changes are consistent with the intended documentation structure.

Workflow ID: wflow_cfRKZfblB3VHg3kF


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@boundaryml/baml uses a native node addon to run the BAML functions. You need to tell NextJS to use the loader for these files.
```JS
/** @type {import('next').NextConfig} */
const nextConfig = {
Copy link
Contributor

Choose a reason for hiding this comment

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

This Next.js configuration is a duplicate of existing configurations found in docs/old/docs/get-started/deploying/nextjs.mdx and fern/01-guide/03-development/deploying/nextjs.mdx. Consider reusing the existing code to avoid duplication.

  • Next.js configuration for @boundaryml/baml (nextjs.mdx)
  • Next.js configuration for @boundaryml/baml (nextjs.mdx)

@aaronvg aaronvg added this pull request to the merge queue Nov 1, 2024
Merged via the queue into canary with commit e0bfc94 Nov 1, 2024
10 checks passed
@aaronvg aaronvg deleted the doc-linkfix branch November 1, 2024 23:42
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.

1 participant