Commit Graph

10 Commits

Author SHA1 Message Date
Mason Daugherty 8d4b9dca79 refs(py): guard against taken ports during serve (#1593) 2025-11-23 02:24:15 -05:00
Mason Daugherty d05c8cd8d9 refs: use --no-sync to prevent uninstalling insiders (#1002) 2025-10-19 20:18:36 -04:00
Mason Daugherty 8e39f250a7 fix: refs build/serve plugin conditional (#999) 2025-10-19 19:49:09 -04:00
Mason Daugherty 7fe1e0b8f8 more ref build fixes (#998) 2025-10-19 19:37:04 -04:00
Mason Daugherty 7ffcf44299 ref docs: use insiders (#993) 2025-10-19 19:02:21 -04:00
Mason Daugherty 06735eb013 refs: disable privacy plugin (#959)
Will re-enable when acquiring sponsor tier (#950)
2025-10-16 20:00:41 +00:00
Mason Daugherty fc9b7f165e wip refs (#863) 2025-10-13 21:38:58 -04:00
Mason Daugherty 78d62b243b oss ref work (#774) 2025-10-07 15:09:47 -04:00
Mason Daugherty b05a15c608 WIP: init consolidate python ref (#701) 2025-10-01 14:21:54 -04:00
Hunter Lovell 910001ce1a feat: reference docs (#640)
Adds a new `reference/` path that centralizes the logic for creating
reference documentation

## For Python

We can leverage the existing reference docs pipeline thats used within
the `langchain` repo, and adapting it to include docs from more sources
(see https://github.com/langchain-ai/langchain/pull/33066). More details
about how this works are in `reference/python/README.md`.

## For TypeScript

We'll be keeping the existing [typedoc](https://typedoc.org/) library to
render references, but we're onshoring the work of consolidating those
into one reference site within this repo.

The basic process of how that happens is:
* by reading a statically defined list of packages and their locations
(defined in reference/javascript/build.ts`)
* doing a shallow clone of each unique repo + branch
* doing the appropriate install steps so that types can be inferred
properly
* extracting package entrypoints by reading the `exports` key in
`package.json`
* pointing typedoc to add those as entrypoints with the [packages
strategy](https://typedoc.org/documents/Options.Input.html#packages)
* building the typedoc outputs to reference/dist/javascript/

## New `make` targets

- `make build-references` will run scripts to format python + js
reference documentation concurrently (which will end up in
reference/dist/)
- `make preview-references` will run aforementioned build scripts and
start a dev server (this won't work until a vercel project is
configured)

## Vercel Setup

In order for these changes to be reflected on `reference.langchain.com`,
a new Vercel project needs to be created (which can happen once this is
merged).

This was tested against a "test" vercel setup and works as expected,
with both reference targets accessible from their respective subpaths
2025-09-24 17:30:34 -04:00