docs: address reviewer feedback from Tab Atkins, annevk, Domenic personas xref.md — add pipeline explanation showing how Reffy/WebRef/xref-service works and what's required for a term to be findable (browser-specs, data-export, Reffy crawl). Addresses Anne's 'the dependency is undocumented'. a11y.md — add table of the four rules disabled by default (color-contrast, landmark-one-main, landmark-unique, region) with reasons. Addresses 'you never list the defaults'. document.respec.md — add full error/warning object fields: title, elements, details, cause (all from RespecError.toJSON()). Addresses Domenic's 'partial docs are worse than no docs'. preProcess.md / postProcess.md — replace toy examples with realistic use cases (fetching external data and injecting dfns; validating output). Addresses Domenic's 'the examples are toys'. data-cite.md — add 'when to use data-cite' decision table; add <dfn data-cite> re-export pattern. Addresses Domenic's 'you never explain the affirmative use case'. Writing-Algorithms.md (new) — algorithm prose conventions: ol.algorithm, variable syntax, standard verbs (Let/Set/Return/Assert/For each), Assert step handling, nested sub-steps, abstract operations, data-algorithm. Addresses the missing 'how to write algorithm prose' gap flagged by both annevk and Domenic. Added to sidebar. _Sidebar.md — add Writing Algorithms to guides section.

marcoscaceres committed Mar 28, 2026

docs: rewrite 30 more pages Linting rules: a11y, check-punctuation, informative-dfn, lint-ignore, no-link-warnings, no-unused-vars, privsec-section data-* attributes: data-abbr, data-format, data-include-format, data-include-replace, data-link-type, data-local-lt, data-lt-no-plural, data-lt-noDefault, data-max-toc, data-number, data-oninclude, data-transform (deprecated), data-type HTML elements: h1-element, idl-index, issue-summary, nohighlight, nolinks, notoc-class, numbered, pre-and-code-elements, section, title-element, tof Config options: dir, doJsonLd, isPreview, lang, latestVersion, maxTocLevel, noTOC, otherLinks, pluralize, respecIsReady, subtitle, canonicalURI, crEnd, prEnd, noRecTrack, processVersion (removed) Deprecated wg* options: wgId, wgURI, wgPatentURI, wgPublicList New/rewritten: document.respec, rs-changelog, gh-contributors, removeOnSave, monetization, format, dark-mode, highlightVars, modificationDate, previousPublishDate, previousMaturity

marcoscaceres committed Mar 27, 2026

Updated a11y (markdown)

sidvishnoi committed Apr 22, 2021

remove reduntant 'Example:' headings as examples are marked already

sidvishnoi committed Jul 8, 2020

mark code snippets as example, add example titles

sidvishnoi committed Jul 6, 2020

/s/github/GitHub

sidvishnoi committed Jun 30, 2020

Run all files through prettier Why? To make all files consistent. Changes can be summarized as: - Remove trailing whitespace - Added EOF newlines - Added newlines between headings and other content - Added semicolons, commas in JS snippets - Formatted all other snippets - Formatted tables (headers are as wide as widest column) - Use - for list markers instead of * - Fix some invalid HTML (i.e., adding missing closing tags) - Changed some snippets for consistency

sidvishnoi committed Jun 30, 2020

nit

sidvishnoi committed Jun 23, 2020

style: use <h1> in each wiki item, fix headings

sidvishnoi committed Jun 17, 2020

add rules override example

sidvishnoi committed Mar 9, 2020

Updated a11y (markdown)

marcoscaceres committed Mar 8, 2020

Updated a11y (markdown)

marcoscaceres committed Mar 8, 2020

Link to rules we disable

marcoscaceres committed Mar 8, 2020

update sample output image

sidvishnoi committed Mar 7, 2020

Created a11y (markdown)

sidvishnoi committed Mar 7, 2020