Repository navigation
Document parser-java, renderer-html and renderer-pdf - #2
Merged
Merged
Conversation
docs/technical covered core, parser-typescript, renderer-markdown and cli only, although the README advertises Java Spring Boot support and HTML and PDF output; the docs index listed the Java parser as "Shipped" with no page. Add a technical reference for each package, link them from docs/README.md, and add a gap row to AUDIT.md saying its coverage figure does not include them. The references record limits found while reading the source: generated HTML loads Mermaid from a CDN at view time, the PDF renderer replaces all non-ASCII text with spaces, the PDF "engine" and "branding" settings are not read, and the Java parser leaves parameter descriptions empty. They were written from the code at 4cbc9e4; the package test suites pass but do not cover the statements marked "by code reading". Change: CONDUIT-2026-001 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The "Build, test, and validate documentation" job fails in its Setup Node.js step: the workflow pins Node 20, but pnpm 11.9.0 requires Node 22.13 or newer and crashes on the missing node:sqlite module when setup-node runs `pnpm store path`. The same failure occurs on main at 4cbc9e4, so the job has not been able to pass independently of this branch. pages.yml already uses Node 22. Only the Node version changes; no step, check or threshold is altered. Locally, install, build, test, e2e and docgen validate pass with this pnpm version on Node 24. Change: CONDUIT-2026-001 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
ADVISORY: RepoScribe documentation validationCoverage: 35% (threshold: 80%) |
naresh-FD
marked this pull request as ready for review
October 17, 2026 04:47
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.
Summary
docs/technicalcovered core, parser-typescript, renderer-markdown and cli only, although the README advertises Java Spring Boot support and HTML and PDF output. The docs index listed the Java parser as Shipped with no page.docs/technical/parser-java.md,renderer-html.mdandrenderer-pdf.md, in the structure of the existing references.docs/README.mdand updates its document count.docs/AUDIT.mdsaying its coverage figure does not include these three packages (the tables were not regenerated).Limits recorded from the source: generated HTML loads Mermaid from a CDN at view time; the PDF renderer replaces all non-ASCII text with spaces; the PDF
engineandbrandingsettings and the HTMLtheme,sidebarandenginesettings are not read; the Java parser leaves parameter descriptions empty.How it was checked
The references were written from the source at
4cbc9e4. Statements marked (by code reading) are not covered by a test. Locally, with pnpm 11.9.0: install,pnpm build(7 of 7),pnpm test --force(14 of 14 tasks),pnpm test:e2e, anddocgen validate(exit 0; coverage 35% against an 80% threshold that is not enforced) all pass. No package defines a lint script.Known, not addressed here
docs/README.mdpoint atapi/*.mdfiles that do not exist). None are new.package-lock.jsonandpnpm-lock.yamlare tracked.CI fix (second commit)
The Build, test, and validate documentation check could not pass on any branch.
.github/workflows/docs.ymlpinned Node 20, but pnpm 11.9.0 needs Node 22.13 or newer and crashes in the Setup Node.js step (No such built-in module: node:sqlite).mainat4cbc9e4fails the same way. The second commit changesnode-versionfrom 20 to 22 (aspages.ymlalready uses) and nothing else. It is separate from the docs commit, so it can be dropped or moved to its own PR without touching the documentation.Change: CONDUIT-2026-001
🤖 Generated with Claude Code