Open
Conversation
There was a problem hiding this comment.
Pull request overview
Sets up the repository’s initial build/tooling for generating a Doc Kit static site, including a prebuild step that generates a shared navigation/authors config consumed by custom theme components.
Changes:
- Add a config-generation script (
prebuild) that fetches nav/i18n/authors and derives sidebar + page author mappings frompages/. - Add Doc Kit configuration plus custom theme components (Navigation/Sidebar/Metabar) wired via
#theme/*imports. - Add baseline repo tooling/docs:
package.jsonscripts/deps, ESLint flat config, README/CONTRIBUTING.
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate-config.mjs | Generates components/config.json from remote JSON + local pages/ content. |
| scripts/constants.mjs | Centralizes paths and remote source URLs used by the generator. |
| package.json | Defines build/lint/format scripts and dependencies (including prebuild). |
| eslint.config.mjs | Adds ESLint flat config with TypeScript + MDX support. |
| doc-kit.config.mjs | Configures Doc Kit generators and maps #theme/* to local components. |
| components/Sidebar/index.jsx | Sidebar component consuming generated sideNav. |
| components/Navigation/index.jsx | Top navigation/search/theme toggle consuming generated topNav. |
| components/Metabar/index.jsx | Metabar/TOC + “Authors” + “Edit this page” consuming generated authors. |
| README.md | Documents repo purpose and local build workflow. |
| CONTRIBUTING.md | Documents content structure and contribution workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Adds some CI + Deployment logic to get this basically set up