Skip to content

DOC-3385: Markdown for Agents - build-time HTML to Markdown conversion#4027

Merged
kemister85 merged 7 commits intomainfrom
feature/markdown-for-agents
Mar 19, 2026
Merged

DOC-3385: Markdown for Agents - build-time HTML to Markdown conversion#4027
kemister85 merged 7 commits intomainfrom
feature/markdown-for-agents

Conversation

@kemister85
Copy link
Contributor

@kemister85 kemister85 commented Mar 16, 2026

Ticket: DOC-3385

Site: N/A (build pipeline change; staging applies after merge)

Changes:

  • Add scripts/generate-markdown.mjs — post-build conversion of Antora HTML to Markdown using dom-to-semantic-markdown (d2m)
  • New package scripts: build:markdown, build:all
  • Update .gitignore — Cursor setup (local only)

Removed: Local content-negotiation test server — kept triggering CodeQL security findings. Local testing can use http-server and .md files directly, or staging.

- Add generate-markdown.mjs: converts Antora HTML to Markdown using d2m
- Add serve-content-negotiation-local-test.mjs: local test server for Accept: text/markdown
- New scripts: build:markdown, build:all, server:negotiate:local-test
- Update .gitignore: Cursor setup (local only)
@kemister85 kemister85 requested a review from a team as a code owner March 16, 2026 11:10
@kemister85 kemister85 requested a review from lostkeys March 16, 2026 11:10
- Add resolutions for brace-expansion, sha.js, lodash, js-yaml, qs, minimatch,
  ecstatic, liquidjs, yauzl to force patched versions
- Fix stale reference to deleted report in generate-markdown.mjs
- yarn audit: 0 vulnerabilities (was 27)
- generate-markdown.mjs: escape backslashes in YAML title (incomplete string escaping)
- serve-content-negotiation-local-test.mjs: resolve and validate path stays within ROOT
Kept triggering CodeQL findings (path traversal, uncontrolled input).
Local testing via http-server + .md files.
@kemister85 kemister85 force-pushed the feature/markdown-for-agents branch from 3a61d74 to f88126e Compare March 16, 2026 11:28
@kemister85 kemister85 force-pushed the feature/markdown-for-agents branch from afe3138 to a34e484 Compare March 16, 2026 11:31
@kemister85 kemister85 requested review from a team, jscasca, metricjs, soritaheng, tiny-ben-tran and tjdett and removed request for a team March 16, 2026 11:37
Copy link
Contributor

@ShiridiGandham ShiridiGandham left a comment

Choose a reason for hiding this comment

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

LGTM

@kemister85 kemister85 merged commit e4200df into main Mar 19, 2026
6 checks passed
@kemister85 kemister85 deleted the feature/markdown-for-agents branch March 19, 2026 03:28
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