fumadocs-mdx -> content-collections #3419
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
There was a problem hiding this comment.
note: empty file was ignored, so an empty frontmatter is necessary
(maybe I could put this in comment, not sure)
There was a problem hiding this comment.
This and all following API files are converted from templates.mts in website. I hope I haven't made any typos while I did that, the conversion process was LLM-assisted.
| Danger.jsonString([pointSet, fn]), | ||
| ] | ||
| result | ||
| `}/> |
There was a problem hiding this comment.
This part is a bit messy: section descriptions contain MDX, but in *.mdx files they're stored as frontmatter string fields. But it's still better than storing it in JS multiline strings. At least the main intro content is the real MDX.
There was a problem hiding this comment.
Note that the schema for content/api frontmatter is type-checked, though! See src/collections/api.ts configuration.
|
|
||
| This is a style guide for how to write good Squiggle code. It's mostly designed to help LLMs write good Squiggle code, but could be useful for humans as well. | ||
|
|
||
| --- |
There was a problem hiding this comment.
The prefix before --- here and in BasicPrompt.mdx will be cut off in LLM system prompt; see content/src/prompts.ts.
This is a bit of an action-at-distance that I dislike because it seems fragile, but at least we check that --- is present in prompts.ts, so there's some safety net.
| @@ -15,9 +15,9 @@ This bot often produces poor results, or fails to properly call the server, so i | |||
|
|
|||
| ## Document with all documentation | |||
|
|
|||
| [All Squiggle Documentation, in One Document](/llms/documentationBundle.markdown) | |||
| [All Squiggle Documentation, in One Document](/api/documentation-bundle) | |||
There was a problem hiding this comment.
Generated just-in-time now.
| @@ -3,8 +3,6 @@ title: Basic Types | |||
| description: Basic types supported by Squiggle | |||
| --- | |||
|
|
|||
| import { SquiggleEditor } from "../../../components/SquiggleEditor"; | |||
There was a problem hiding this comment.
Imports in MDX are not allowed anymore; instead, we pass the full list of components in website configuration.
This is one significant downside of this PR, but it's kind of unavoidable because of how MDX works.
| throw new Error(`Invalid response: ${JSON.stringify(json, null, 2)}`); | ||
| } | ||
| return code; | ||
| } |
There was a problem hiding this comment.
Copy-pasted from AI where similar code is used for fine-tuning.
In the future, we can move both to packages/hub-client library.
| const docs = allDocs.filter((doc) => doc._meta.directory === directory); | ||
|
|
||
| // Sort docs by the order of the pages in the Guides metadata. | ||
| // This matches Fumadocs behavior, which we assume is the most natural ordering both for humans and LLMs. |
There was a problem hiding this comment.
I'm not sure how important this is, previously the pages weren't sorted, but it wasn't very hard to implement.
| import { squiggleSystemPrompt } from "@quri/squiggle-ai/server"; | ||
|
|
||
| export async function GET() { | ||
| return new Response(squiggleSystemPrompt); |
There was a problem hiding this comment.
https://squigglehub.org/ai/api/system-prompt will be useful for checking that system prompt was generated correctly (many ways to make a mistake there, e.g. once I forgot an await, and documentation bundle was injected as [object Promise])
There was a problem hiding this comment.
https://squiggle-language.com/api/documentation-bundle (after this PR is merged), linked from docs
| extension: "json", | ||
| path: "Api/meta", | ||
| }, | ||
| }, |
There was a problem hiding this comment.
See also: the comment in content/src/collections/docs.ts, on how apiDocs is a separate collection
|
App looks fine now. Will review some parts of the code later, when I work in these areas, but I expect it to broadly be okay now. |
Notes:
<MDXContent components={{...}}>whitelistTODO: