docs: add CHANGELOG and programmatic API usage to README#1636
Merged
Conversation
kitsuyui
force-pushed
the
fix/audit-docs-no-changelog-library-api-001
branch
from
June 10, 2026 17:36
80b0aa4 to
521c004
Compare
Code Metrics Report
Details | | main (1c1db53) | #1636 (feca1b5) | +/- |
|---------------------|----------------|-----------------|-------|
- | Coverage | 87.5% | 86.9% | -0.7% |
| Files | 11 | 11 | 0 |
| Lines | 201 | 207 | +6 |
+ | Covered | 176 | 180 | +4 |
+ | Code to Test Ratio | 1:0.5 | 1:0.5 | +0.0 |
| Code | 1591 | 1648 | +57 |
+ | Test | 913 | 961 | +48 |
- | Test Execution Time | 6s | 7s | +1s |Code coverage of files in pull request scope (79.1% → 76.9%)
Reported by octocov |
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
CHANGELOG.mdfollowing the Keep a Changelog formatREADME.mddocumenting theserverandclinamespaces exported fromsrc/index.tsMotivation
rendering-proxyis published as an npm package (version: 0.1.0) withdist/index.d.tstype definitions. Thesrc/index.tsre-exports bothserverandclinamespaces, so consumers can import the library programmatically — but until now there was no example or reference for how to do so. Similarly, a package without a CHANGELOG makes it difficult for consumers to evaluate the impact of version updates.Changes
CHANGELOG.md: initial file anchored to0.1.0; points to git log for full prior historyREADME.md: new## Programmatic APIsection documentingserver.main,server.createServer,server.createHandler,cli.renderToStream, andcli.mainwith TypeScript examplesVerification
biome check .passes (30 files, no issues)Trade-offs
The CHANGELOG starts from
0.1.0with a pointer to git log rather than back-filling every historical release; back-filling would be error-prone and the git log already captures that history accurately.