Skip to content

feat(scripts): add scripts, packages, components, and config files#2

Merged
avivkeller merged 1 commit intomainfrom
scripts
Mar 28, 2026
Merged

feat(scripts): add scripts, packages, components, and config files#2
avivkeller merged 1 commit intomainfrom
scripts

Conversation

@avivkeller
Copy link
Copy Markdown
Member

@avivkeller avivkeller commented Mar 25, 2026

Adds some logic to get this basically set up. cc @nodejs/web-admins for deployment previews

Copilot AI review requested due to automatic review settings March 25, 2026 17:15
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 from pages/.
  • Add Doc Kit configuration plus custom theme components (Navigation/Sidebar/Metabar) wired via #theme/* imports.
  • Add baseline repo tooling/docs: package.json scripts/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.

@avivkeller avivkeller requested a review from a team March 25, 2026 20:59
Copy link
Copy Markdown
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM! Left tiny comments and the PR title should probably match that it adds the scripts and initial packages and components :)

@canerakdas
Copy link
Copy Markdown
Member

adding .editorconfig would be great before merging any script 🙏

Ref: https://github.com/nodejs/doc-kit/blob/main/.editorconfig

@canerakdas
Copy link
Copy Markdown
Member

@avivkeller
Copy link
Copy Markdown
Member Author

@canerakdas Yes, when I copied code from my demo, the .* files didn't copy haha

@avivkeller avivkeller changed the title feat(scripts): set up feat(scripts): add scripts, packages, components, and config files Mar 28, 2026
@avivkeller avivkeller merged commit d699f9b into main Mar 28, 2026
2 checks passed
@avivkeller avivkeller deleted the scripts branch March 28, 2026 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants