Docs
A review of contributing.md and repository configurations revealed a dead table-of-contents link, several unclosed HTML formatting tags, and missing tooling scripts:
1. Broken TOC Anchor in contributing.md
- Location:
contributing.md line 20 vs line 133
- Details:
The Table of Contents links to:
- [Local Development](#local-development)
However, the section header on line 133 is named:
Clicking the TOC link results in a dead anchor jump.
- Fix: Update line 20 to
- [Working Locally](#working-locally) or rename the section header to ## Local Development.
2. Malformed / Unclosed HTML <p> Tags in contributing.md
- Location:
contributing.md lines 99, 114, and 122
- Details:
Several bullet points under the Guidelines section open with <p><strong>...</strong><br/> but lack closing </p> tags before subsequent markdown list items, causing invalid HTML structure in some markdown renderers.
- Fix: Clean up raw HTML tags and replace them with standard Markdown formatting.
3. Missing typecheck Script in package.json
- Location:
package.json
- Details:
TypeScript and @types/node are installed as dev dependencies, but there is no "typecheck": "tsc --noEmit" script to validate the integrity of the TypeScript scripts in scripts/. Adding this script would enable contributors and CI to verify TypeScript types on future changes.
Happy to submit a quick PR to fix these formatting and documentation issues.
Docs
A review of
contributing.mdand repository configurations revealed a dead table-of-contents link, several unclosed HTML formatting tags, and missing tooling scripts:1. Broken TOC Anchor in
contributing.mdcontributing.mdline 20 vs line 133The Table of Contents links to:
## Working Locally- [Working Locally](#working-locally)or rename the section header to## Local Development.2. Malformed / Unclosed HTML
<p>Tags incontributing.mdcontributing.mdlines 99, 114, and 122Several bullet points under the Guidelines section open with
<p><strong>...</strong><br/>but lack closing</p>tags before subsequent markdown list items, causing invalid HTML structure in some markdown renderers.3. Missing
typecheckScript inpackage.jsonpackage.jsonTypeScript and
@types/nodeare installed as dev dependencies, but there is no"typecheck": "tsc --noEmit"script to validate the integrity of the TypeScript scripts inscripts/. Adding this script would enable contributors and CI to verify TypeScript types on future changes.Happy to submit a quick PR to fix these formatting and documentation issues.