Skip to content

Website audit: fix factual inaccuracies, relocate Too Many Cooks, add dart_node_sql_js#63

Merged
MelbourneDeveloper merged 2 commits into
mainfrom
website-audit-factual-fixes
Jun 8, 2026
Merged

Website audit: fix factual inaccuracies, relocate Too Many Cooks, add dart_node_sql_js#63
MelbourneDeveloper merged 2 commits into
mainfrom
website-audit-factual-fixes

Conversation

@MelbourneDeveloper

Copy link
Copy Markdown
Owner

TLDR

Hard audit of the docs website: stubs out the relocated Too Many Cooks, fixes factual inaccuracies (publisher, GitHub casing, social handle, stale versions, broken links, wrong API code examples), surfaces the published dart_node_sql_js, and repairs SEO/social metadata.

What Was Added?

  • dart_node_sql_js surfaced everywhere it was missing: homepage stack card (en/zh), homepage ItemList schema, docs nav (en/zh), API index (en/zh), a generated docs page, and a new Chinese README (packages/dart_node_sql_js/README_zh.md). Added to the docs-generation and API-generation pipelines.
  • og-image.png (1200×630) and apple-touch-icon.png (180×180) — the social-card/JSON-LD image and apple-touch-icon were referenced everywhere but the files did not exist (404). Generated branded assets.
  • nimblesite.co copyright link in the footer.

What Was Changed or Deleted?

  • Too Many Cooks moved to https://tmc-mcp.dev: homepage cards (en/zh) and the MCP & vsix READMEs now point there and state it is no longer part of this repo. Removed from the homepage package ItemList (it is not a dart_node package).
  • Factual corrections (sitewide): pub.dev publisher dartnode.devchristianfindlay.com (verified); GitHub casing → MelbourneDeveloper; X/Twitter @dart_node@cfdevelop (the real, active handle).
  • Unpublished packages (dart_jsx, dart_node_vsix, both publish_to: none) no longer link to 404 pub.dev pages — they link to GitHub source. The docs-generator does this automatically for any unpublished package.
  • Broken links: footer /docs/examples/ (no such page) → GitHub examples; 125 broken /api/../… dartdoc cross-links fixed by collapsing the full leading ../ run in the API link rewriter.
  • Stale versions: install snippets ^0.11.0-beta^0.13.0-beta (latest published); wrong nadz: ^0.9.0^0.0.7-beta (actual constraint).
  • Code examples in package READMEs/blog corrected to the real package APIs (react text()→string / p()pEl / Document.getElementById / button(text:); react_native image()rnImage, flatList signature, ScreenProps; express req.params access + dart:js_interop_unsafe import + router mount; mcp full 5-field ToolConfig; better_sqlite3 Result handling; logging LogFunction transport signature).
  • dart-to-js doc: -O1 is the dart2js default (was wrongly -O2), removed a reference to a nonexistent build tool, fixed the --dump-info reference.
  • Removed a phantom SearchAction from the WebSite JSON-LD (no /search route exists); shortened an over-long (67-char) blog <title>.
  • Upgraded eleventy-plugin-techdoc 0.1.0 → 0.2.0 and @11ty/eleventy → 3.1.6, and audited the upgraded output.

How Do The Automated Tests Prove It Works?

  • npm run build completes with 0 warnings / 0 errors across all 10 packages' dartdoc + Eleventy (2424 pages), including the newly-added dart_node_sql_js API docs.
  • A full internal-link crawl of the generated _site dropped broken targets from 177 → 52; every remaining target is pre-existing (see below), and a string sweep confirms 0 occurrences of the old publisher / GitHub casing / @dart_node / /docs/examples / too_many_cooks package links.
  • Each code-example change was reviewed in the git diff against the actual package lib/ (and test//example/) — e.g. flatList(JSArray data, JSFunction renderItem, props:), ToolConfig 5-field record matching runtime_test.dart, LogFunction = void Function(LogMessage, LogLevel) matching log_to_console.dart.
  • Playwright (1280×720 and 375×667): homepage, /docs/react/, /docs/sql-js/ (en/zh), /docs/getting-started/ load with no console errors; og-image.png/apple-touch-icon.png return 200.

Known pre-existing issues (not introduced here, out of scope): 40 links on the dart_logging API landing page (its two-library dartdoc layout isn't mapped to member pages by the generator), 10 hreflang/language-switcher links to untranslated zh blog pages, and 2 reflux dartdoc self-links.

Spec / Doc Changes

This PR is primarily docs/website. Package README.md/README_zh.md files were edited (they are the source for the generated docs pages); no library code, pubspecs, or tests were changed.

Breaking Changes

  • None

…face dart_node_sql_js

- TMC moved to tmc-mcp.dev: homepage cards (en/zh), MCP/vsix READMEs now point there; removed from homepage package ItemList
- Correct facts sitewide: pub.dev publisher christianfindlay.com (was dartnode.dev), GitHub MelbourneDeveloper casing, X handle @cfdevelop (was @dart_node)
- Unpublished packages (dart_jsx, dart_node_vsix) link to GitHub source instead of 404 pub.dev pages
- Add published dart_node_sql_js across homepage (en/zh), nav, API index, docs page (+ new Chinese README/docs/API)
- Bump stale install snippets 0.11.0-beta -> 0.13.0-beta; fix nadz ^0.9.0 -> ^0.0.7-beta
- Fix broken links: footer /docs/examples -> GitHub examples; 125 broken /api/../ dartdoc cross-links (link rewriter collapses all leading ../)
- Correct README/blog code examples to the real package APIs (react, react_native, express, mcp, better_sqlite3, logging)
- dart-to-js: -O1 is the dart2js default (not -O2), drop nonexistent build tool, fix --dump-info reference
- SEO/social: generate og-image.png (1200x630) + apple-touch-icon.png, remove phantom SearchAction schema, shorten over-long blog title, add nimblesite.co footer copyright
- Upgrade eleventy-plugin-techdoc 0.1.0 -> 0.2.0 and @11ty/eleventy -> 3.1.6
CI's npm ci requires package-lock.json to match package.json; the lockfile
still pinned eleventy-plugin-techdoc 0.1.0 / @11ty/eleventy 3.1.2 while
package.json was bumped to ^0.2.0 / ^3.1.6. Regenerate so npm ci passes.
@MelbourneDeveloper MelbourneDeveloper merged commit 2e816b3 into main Jun 8, 2026
4 checks passed
@MelbourneDeveloper MelbourneDeveloper deleted the website-audit-factual-fixes branch June 8, 2026 02:43
MelbourneDeveloper added a commit that referenced this pull request Jun 9, 2026
… dart_node_sql_js (#63)

## TLDR
Hard audit of the docs website: stubs out the relocated Too Many Cooks,
fixes factual inaccuracies (publisher, GitHub casing, social handle,
stale versions, broken links, wrong API code examples), surfaces the
published `dart_node_sql_js`, and repairs SEO/social metadata.

## What Was Added?
- **`dart_node_sql_js`** surfaced everywhere it was missing: homepage
stack card (en/zh), homepage `ItemList` schema, docs nav (en/zh), API
index (en/zh), a generated docs page, and a new Chinese README
(`packages/dart_node_sql_js/README_zh.md`). Added to the docs-generation
and API-generation pipelines.
- **`og-image.png` (1200×630)** and **`apple-touch-icon.png` (180×180)**
— the social-card/JSON-LD image and apple-touch-icon were referenced
everywhere but the files did not exist (404). Generated branded assets.
- **nimblesite.co** copyright link in the footer.

## What Was Changed or Deleted?
- **Too Many Cooks** moved to https://tmc-mcp.dev: homepage cards
(en/zh) and the MCP & vsix READMEs now point there and state it is no
longer part of this repo. Removed from the homepage package `ItemList`
(it is not a `dart_node` package).
- **Factual corrections (sitewide):** pub.dev publisher `dartnode.dev` →
`christianfindlay.com` (verified); GitHub casing → `MelbourneDeveloper`;
X/Twitter `@dart_node` → `@cfdevelop` (the real, active handle).
- **Unpublished packages** (`dart_jsx`, `dart_node_vsix`, both
`publish_to: none`) no longer link to 404 pub.dev pages — they link to
GitHub source. The docs-generator does this automatically for any
unpublished package.
- **Broken links:** footer `/docs/examples/` (no such page) → GitHub
examples; **125 broken `/api/../…` dartdoc cross-links** fixed by
collapsing the full leading `../` run in the API link rewriter.
- **Stale versions:** install snippets `^0.11.0-beta` → `^0.13.0-beta`
(latest published); wrong `nadz: ^0.9.0` → `^0.0.7-beta` (actual
constraint).
- **Code examples** in package READMEs/blog corrected to the real
package APIs (react `text()`→string / `p()`→`pEl` /
`Document.getElementById` / `button(text:)`; react_native
`image()`→`rnImage`, `flatList` signature, `ScreenProps`; express
`req.params` access + `dart:js_interop_unsafe` import + router mount;
mcp full 5-field `ToolConfig`; better_sqlite3 `Result` handling; logging
`LogFunction` transport signature).
- **dart-to-js doc:** `-O1` is the dart2js default (was wrongly `-O2`),
removed a reference to a nonexistent build tool, fixed the `--dump-info`
reference.
- Removed a phantom `SearchAction` from the WebSite JSON-LD (no
`/search` route exists); shortened an over-long (67-char) blog
`<title>`.
- Upgraded `eleventy-plugin-techdoc` 0.1.0 → 0.2.0 and `@11ty/eleventy`
→ 3.1.6, and audited the upgraded output.

## How Do The Automated Tests Prove It Works?
- `npm run build` completes with **0 warnings / 0 errors** across all 10
packages' dartdoc + Eleventy (2424 pages), including the newly-added
`dart_node_sql_js` API docs.
- A full internal-link crawl of the generated `_site` dropped broken
targets from **177 → 52**; every remaining target is pre-existing (see
below), and a string sweep confirms **0** occurrences of the old
publisher / GitHub casing / `@dart_node` / `/docs/examples` /
`too_many_cooks` package links.
- Each code-example change was reviewed in the git diff against the
actual package `lib/` (and `test/`/`example/`) — e.g. `flatList(JSArray
data, JSFunction renderItem, props:)`, `ToolConfig` 5-field record
matching `runtime_test.dart`, `LogFunction = void Function(LogMessage,
LogLevel)` matching `log_to_console.dart`.
- Playwright (1280×720 and 375×667): homepage, `/docs/react/`,
`/docs/sql-js/` (en/zh), `/docs/getting-started/` load with **no console
errors**; `og-image.png`/`apple-touch-icon.png` return 200.

**Known pre-existing issues (not introduced here, out of scope):** 40
links on the `dart_logging` API landing page (its two-library dartdoc
layout isn't mapped to member pages by the generator), 10
hreflang/language-switcher links to untranslated zh blog pages, and 2
reflux dartdoc self-links.

## Spec / Doc Changes
This PR is primarily docs/website. Package `README.md`/`README_zh.md`
files were edited (they are the source for the generated docs pages); no
library code, pubspecs, or tests were changed.

## Breaking Changes
- [x] None
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant