Repository navigation
docs: fix dead links, stale versioning, and API-reference extraction - #34
Merged
Merged
Conversation
…traction - SUPPLY-CHAIN.md: repair the broken COMPLIANCE.md §5 link and an unfinished sentence - ADRs 0003/0005: point OBJECTIVES.md links at ../OBJECTIVES.md so they resolve - VERSIONING.md: drop the specific stale version numbers (pre-1.0, 0.x range) - gen-api-reference.mjs: anchor doc summaries to each declaration so module headers are no longer mis-attributed, and resolve re-exported symbols' kind/summary from their source module. Regenerated API.md (276/331 summaries now correct; surface snapshot unchanged).
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.
Repo-polish pass from an audit for anything that reads as unfinished or broken to an outside reviewer. Docs and one generator fix only — no changes to package code or the public API surface.
Changes
COMPLIANCE.md §5link (it contained a literal space) and finish a garbled sentence ("operationalises and the supply-chain section").OBJECTIVES.mdlinks resolved todocs/adr/OBJECTIVES.md(nonexistent); point them at../OBJECTIVES.md.0.5.0 tagged; 0.4.4 published) that no longer matched the packages; state the pre-1.00.xreality version-agnostically.docFormatched adoc-comment … export NAMEpair left-to-right, so a file's module header was mis-attributed as the summary of the first documented symbol. Now it anchors to the declaration and only uses a JSDoc block sitting directly above it.export { … } fromre-exports were given an empty summary. Now their kind and summary are resolved from the source module, the same wayexport * fromalready did.Verification
api:checkpasses;api-surface.jsonis byte-identical (the frozen contract is untouched — names/order unchanged).API.md: correct summaries went from mostly module-header-leakage to 276/331; the remaining 55 are honestly blank (genuinely undocumented symbols) rather than mis-labeled.node --checkandprettier --checkclean on all touched files.Follow-up (not in scope): the 55 blank summaries want real JSDoc on their source declarations.