Skip to content

Conversation

beklapko
Copy link
Contributor

@beklapko beklapko commented Sep 8, 2025

Summary

There are three main changes in this PR but they're spread across a lot of docs.

  1. This tooltip was removed (the callout linked to a page that's in the old docs but not the new docs, and didn't seem critical to me to have right now).
import IntegrationInstallTooltip from '/snippets/javascript-integrations/integration-install-tooltip.mdx';

<IntegrationInstallTooltip/>
  1. Installation code blocks like this didn't migrate so well.
<Npm2Yarn>
  @arcjet/redact
</Npm2Yarn>

For now, I've replaced these with code groups (below is just an example, each code group is different based on the library getting installed)

<CodeGroup>
```bash npm
npm install @arcjet/redact
```
```bash yarn
yarn add @arcjet/redact
```
```bash pnpm
pnpm add @arcjet/redact
```
</CodeGroup>

There is probably a smarter/better long term way to do this with snippets but this was doable in the short term to fix the missing example/broken rendering.

  1. Some tooltips and snippets got put in these {=mdx} blocks:
```{=mdx}
<Warning>
**Compatibility**

This feature is currently in beta.
</Warning>
```

So I removed the opening and closing "tags" which fixes the rendering issues.

Unresolved issue

This snippet shows up in several places:

<ChatModelTabs customVarName="llm" />

It was enclosed with {=mdx} and the triple backticks which caused it to be rendered like this in prod:

Screenshot 2025-09-08 at 1 32 06 PM

I removed the enclosing {=mdx} so it doesn't get rendered at all, but this doesn't fix the issue entirely. That snippet, from what I can tell, should render out something like this section in the old JS docs: https://js.langchain.com/docs/integrations/retrievers/exa/#use-within-a-chain.

It'd take more time and research to see if we can actually recreate that functionality here or not, which this PR does not address.

Testing

I spot checked a few instances of each of these changes locally but I did not verify every change in every file.

Copy link

github-actions bot commented Sep 8, 2025

Preview ID generated: preview-brodyp-1757358965-579ec3d

@mdrxy mdrxy added the langchain For docs changes to LangChain label Sep 8, 2025
Copy link

github-actions bot commented Sep 8, 2025

Preview ID generated: preview-brodyp-1757361202-60a1624

Copy link

github-actions bot commented Sep 8, 2025

Preview ID generated: preview-brodyp-1757361421-9918912

@beklapko beklapko mentioned this pull request Sep 8, 2025
@beklapko beklapko marked this pull request as ready for review September 8, 2025 20:03
@beklapko
Copy link
Contributor Author

beklapko commented Sep 8, 2025

Related but closed PR just for reference: #381.

I created this PR to fix additional stuff but also to start fresh on main.

@beklapko beklapko marked this pull request as draft September 8, 2025 20:17
@beklapko beklapko marked this pull request as ready for review September 8, 2025 20:38
Copy link

github-actions bot commented Sep 9, 2025

Preview ID generated: preview-brodyp-1757439274-b691185

Copy link

github-actions bot commented Sep 9, 2025

Preview ID generated: preview-brodyp-1757444592-1cee34e

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

Successfully merging this pull request may close these issues.

2 participants