Repository navigation
fix(ci): lint-readme green — lychee.toml parse error, markdownlint config + content fixes - #163
Merged
Merged
Conversation
lychee exited 3 before checking a single link: its config keys are top-level, so the `[lychee]` table header made the whole file an unknown-field parse error. Dropping the header keeps every existing exclude and lets the offline check run (64 OK, 0 errors). The lint-readme workflow was ported from embeddedos-org/embeddedos-org in 6fc5b85 without the .markdownlint.yml it runs with there (9475a30), so markdownlint ran on defaults and reported 476 errors, 253 of them MD060 table-pipe style. Port that config (MD013 tables exempt, MD060 consistent) and add MD024 siblings_only: the ecosystem guide repeats Overview/Key Features/Architecture under every chapter; duplicate headings under the same parent are still reported. Refs #162
Content fixes for the 174 markdownlint errors left after the config commit, following the embeddedos-org cleanup (87c3262): - ecosystem guide: the TOC links to em-dash anchors but chapter headings used `--`, so all 18 chapter links were dead (MD051). Use the em dash the TOC and the front-matter title already use. - ecosystem guide: the body H1 duplicated the front-matter title and every Part was another H1 (MD025). Drop the duplicate and demote the Part/Appendices subtree one level, so there is one title. - `text` on 27 bare diagram/tree fences (MD040); autolink bare URLs and emails, backtick the repo name in merge-proposal (MD034); join example quotes with `>` (MD028); missing blank lines (MD022/MD032), extra blank line (MD012), stray H1 in CLAUDE.md (MD025); byline and colophon kept on two lines via a hard break instead of emphasis-only paragraphs (MD036); prose reflowed to 80 columns (MD013) with wording unchanged. Fixes #162
Member
Author
|
The failing
This PR doesn't touch HTML, JS or Playwright config. I've kept that fix out of this PR so its scope stays limited to #162. |
Firefox renders XML in its own viewer, where page.textContent('body') never
resolves, so 'sitemap.xml is valid' timed out on Firefox once the browser
was actually installed. The test now fetches the file and checks it is a
<urlset> naming the site.
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.
Fixes #162
lint-readmehas been red onmastersince the port in 6fc5b85.lychee —
lychee.tomlfailed to parse (unknown field 'lychee'at[lychee]); config keys are top-level. Removed the table header; the excludes stay as they were.markdownlint — the workflow was ported without the
.markdownlint.ymlit uses inembeddedos-org/embeddedos-org(9475a30). This PR ports it, plusMD024 siblings_onlyfor the guide's repeated per-chapter subsections. The 174 errors left after that are fixed in the content, not by disabling rules. Notable fix: all 18 chapter links in the ecosystem guide TOC were broken (headings used--, the anchors expect—). The guide also had one body H1 too many, and each Part was its own H1: I removed the H1 that duplicated the front-matter title and moved Parts/Appendices down one level.No checks were disabled; no
continue-on-error.Local verification (workflow's own commands, lychee 0.24.2 as in CI):