Repository navigation
docs: clean up AI-written prose in docs and comments - #609
Conversation
|
Note The title starts with
|
|
The latest updates on your projects. Learn more about Vercel for GitHub. 9 Skipped Deployments
|
|
Important Review skippedToo many files! This PR contains 345 files, which is 195 over the limit of 150. To get a review, reduce the PR to 150 files or fewer by splitting it into smaller PRs or changing its base branch. Upgrade to a paid plan to raise the limit. Usage-priced reviews support at most 300 files.
|
b8fdebf to
94872d4
Compare
comark
@comark/angular
@comark/ansi
@comark/html
@comark/nuxt
@comark/react
@comark/svelte
@comark/vue
commit: |
What
Strips AI-generated prose patterns, brochure vocabulary, decorative emoji bullets, and narrated code comments across 344 documentation and source files (
+3,571 / -5,996lines), fixes stale paths and version references uncovered during the audit, and tightensAGENTS.mdfrom 1,102 lines down to 336 lines. Runtime logic, public TypeScript signatures, test assertions, andSPEC/fixtures are untouched.Why
Generated prose and comments had accumulated across older docs pages, package
README.mds,AGENTS.md, and source files: 467 em dashes across Markdown and code comments, 44 ASCII section divider banners, line-by-line narrated comments that buried real security and parser invariants, copied::code-explorerfrontmatter in GitHub-renderedexamples/**/README.mdfiles, and stale paths and Angular version numbers. Cleaning these in one pass aligns older docs with the direct style introduced in #477, reduces.d.tsandREADME.mdweight in published tarballs, and cutsAGENTS.mdcontext overhead by 70%.Evidence
main(before)162files, excludingSPEC/)punctuationplugin output examples only)AGENTS.mdlinescomarkunpacked tarball (npm pack --dry-run)444k (173 files)439k (173 files)@comark/vue/@comark/svelte/@comark/angulartarballs62.8k/51.2k/70.0k62.5k/50.8k/69.7kVerification runs on this branch (all exit code
0):pnpm test:comark(71files,2,111passed,4skipped),@comark/html(76passed),@comark/ansi(118passed),@comark/vue(120passed),@comark/reactserver + Chromium (90passed),@comark/svelteserver + Chromium (144passed),@comark/angular(74passed), exit code0.pnpm test:sanitizer:2files,437passed, exit code0.pnpm prepack && pnpm vitest run test/bundle.test.ts:1file,2passed, exit code0.Details
titleandseo.titlecasing from docs: SEO and AEO pass (positioning, titles, llms.txt, use cases, comparisons) #477, smart-typography output examples inpunctuation.mdandvue-vite-punctuation,Made with ❤️footers inREADME.mdfiles,// #regionfolding markers, Twoslash// ---cut---directives,@ts-expect-errorchecks, and allSPEC/andtest/sanitizer/fixtures/test inputs.test/bundle.test.tsis updated in this PR because TypeScript emits exported JSDoc comments into.d.tsfiles andnpm packincludes each package'sREADME.md.comark-lintverified all Comark components, links, and heading anchors acrossdocs/content/**/*.md, and the docs preview workflow builds the site on CI.ELI5
Over time, AI-assisted edits left robotic phrasing, decorative emojis, and obvious step-by-step comments scattered across Comark's documentation and source code. This change rewrites those docs in plain English, deletes comments that only repeat what the next line of code already says, and fixes outdated links and version numbers we found along the way. No code behavior changed, and the published packages are slightly smaller because the extra comment text is gone.
Walkthrough
Documentation, skills, and READMEs
docs/content/7.kb/0.why-comark.md),"not just X, but Y"framing, trailing-ingcommentary clauses, reader-dismissive words (simply,easily), Latin abbreviations (e.g.,i.e.), em dashes, and brochure vocabulary (seamless,crucial,first-class,out of the box,under the hood,battle-tested).packages/*/README.mdanddocs/skills/comark/SKILL.md.examples/**/README.mdfiles from copied docs-site::code-explorerfrontmatter into plain GitHub Flavored Markdown so they render properly on GitHub.Angular 17+references toAngular 21+, added@comark/angulartoSECURITY.md, updated/api/parseand5.api/links to/reference/..., and fixed MDC-era bare binding examples and broken relative links indocs/README.mdanddocs/skills/.Code comments, JSDoc, and bundle snapshot
// Check if we start with $$,// Handle text nodes,// Set inputs), ASCII section divider banners, dead commented-out code, diff-talk phrasing ((the previous behavior)), and signature-restating@paramtags inpackages/comark/src/types.ts.O(n)/ allocation constraints, framework SSR quirks, and CommonMark/GFM/MDC spec subtleties, rewriting their punctuation to plain ASCII.test/bundle.test.ts.Agent instructions (
AGENTS.md)Package exports referencesection and removed generic Vitest tutorials.playground/and.release-it.jsonnotes, updatedpackages/comark/src/internal/(parse/tree.tsinstead oftoken-processor.ts;src/plugins/linkify.tsforlinkify-it), corrected@comark/angular's component layout andsync-plugins.mjsexport generation, and added7.kb/,8.examples/,9.ecosystem.md, anddocs/skills/to the docs map.