docs: Redesign public docs with Starlight#63
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Move the public docs onto Starlight with a reusable local theme, generated API reference pages, and structured docs content. Rework the docs narrative around choosing a harness and following the Paris eval example through app shape, harness configuration, and judging. Tighten code block chrome, copy controls, and monochrome docs styling for the long-term documentation site. Co-Authored-By: OpenAI Codex <codex@openai.com>
dcramer
force-pushed
the
ref/docs-redesign
branch
from
dee91bd to
19c5649
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| }), | ||
| ], | ||
| }), | ||
| mdx(), |
There was a problem hiding this comment.
Bug: The explicit mdx() integration in astro.config.mjs is redundant because starlight() already provides MDX support, which could cause build conflicts or warnings.
Severity: LOW
Suggested Fix
Remove the explicit mdx() call from the integrations array in astro.config.mjs. Rely on the built-in MDX support provided by the starlight integration, which is sufficient for the project's needs.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: packages/docs/astro.config.mjs#L102
Potential issue: The Astro configuration file `astro.config.mjs` includes both the
`starlight()` and `mdx()` integrations. The `starlight` integration handles MDX
processing internally, making the explicit inclusion of the `mdx()` integration
redundant. This configuration follows a pattern that can lead to build-time warnings or
conflicts related to initialization order, even if modern versions of Astro might handle
it silently. Since all MDX content is managed by Starlight's content loader, the
separate `mdx()` integration is unnecessary and should be removed to follow best
practices and avoid potential issues.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Redesign the public docs around Starlight and a harness-first documentation flow. The docs now route readers to the right harness, then carry a consistent Paris example through app shape, harness configuration, evals, and judges.
Starlight Docs
Move docs and generated API pages into Starlight with a local monochrome theme, reusable docs writing policy, and structured harness and judge templates.
Code Block Styling
Normalize code block chrome with borderless high-contrast backgrounds, single-dot terminal headers, hidden untitled titlebars, and centered borderless copy controls.