Skip to content

fix: include Markdown files in generated site#23

Open
ColumbusLabs wants to merge 1 commit into
nodejs:mainfrom
ColumbusLabs:codex/include-markdown-files
Open

fix: include Markdown files in generated site#23
ColumbusLabs wants to merge 1 commit into
nodejs:mainfrom
ColumbusLabs:codex/include-markdown-files

Conversation

@ColumbusLabs

@ColumbusLabs ColumbusLabs commented Jul 25, 2026

Copy link
Copy Markdown

Fixes #9.

Copies each fetched Markdown file into its matching generated version directory after doc-kit succeeds. This makes the MetaBar's “View As: MD” links resolve for every supported major without publishing doc-kit configuration inputs.

Every release builds under /v<major>.x/, including the current latest at /v8.x/. Vercel temporarily redirects / to /v8.x, while the pre-existing legacy redirect remains unchanged. Supplied sidebar links are made version-aware for the versioned layout.

AI assistance was used to investigate, implement, validate, and review this change, in accordance with the OpenJS AI Coding Assistants Policy. The commit includes the recommended Assisted-by: OpenAI Codex attribution.

Validation:

  • clean full npm run build across v8.9.0, v7.29.0, and v6.28.0
  • all 122 fetched Markdown files present byte-for-byte at their published versioned output paths
  • non-Markdown inputs such as site.json and type-map.json are not copied
  • generated HTML contains no root-relative documentation/sidebar links
  • temporary root redirect and unchanged legacy redirect verified from vercel.json
  • syntax check and git diff --check
  • independent constrained review: no findings

@vercel

vercel Bot commented Jul 25, 2026

Copy link
Copy Markdown

@ColumbusLabs is attempting to deploy a commit to the OpenJS Foundation Team on Vercel.

A member of the Team first needs to authorize it.

@avivkeller avivkeller left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should output to v5.x, and use Vercel redirects for /

@ColumbusLabs
ColumbusLabs force-pushed the codex/include-markdown-files branch from b109b7c to f831097 Compare July 25, 2026 12:45
@ColumbusLabs

ColumbusLabs commented Jul 25, 2026

Copy link
Copy Markdown
Author

Updated in 4bd42e9 and narrowed to the maintainer-requested scope.

  • Every release now builds and publishes under its versioned major path, including the current latest at /v8.x/.
  • Vercel redirects / to /v8.x with permanent: false; the existing /docs/docs/* redirect is unchanged.
  • Updater changes/tests, canonical changes, and root-404 copying were removed.
  • The source copy is Markdown-only and preserves relative directories.
  • Supplied sidebar links remain functional under the versioned routes.

Validation passed with a clean full build across v8.9.0, v7.29.0, and v6.28.0; byte-identical checks for all 122 fetched Markdown files; confirmation that site.json and type-map.json are not copied; and a generated-link audit showing no root-relative documentation/sidebar links. Independent constrained review found no issues.

Comment thread vercel.json Outdated
Comment thread vercel.json
Comment thread test/update-versions.test.mjs Outdated
Comment thread template.html
Comment thread scripts/build-html.mjs Outdated
@ColumbusLabs
ColumbusLabs force-pushed the codex/include-markdown-files branch from f831097 to 4bd42e9 Compare July 25, 2026 13:49
@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
undici-website Ready Ready Preview, Comment Jul 27, 2026 3:25am

Request Review

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.

.md file ins't included

2 participants