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: fix validation errors in 4 pages - data-dfn-type.md: completely rewrote with accurate types from dfn.js knownTypesMap (abstract-op, attr-value, element, element-attr, element-state, event, http-header, media-type, scheme, permission). Previous version incorrectly listed IDL types as manual data-dfn-type values — those are set automatically by the WebIDL parser. - preProcess.md, postProcess.md: functions receive (config, document, utils) not (config, document). Added utils argument and signature table. - caniuse.md: added missing browser IDs (and_uc, opera) with browser table.

marcoscaceres committed Mar 27, 2026

docs: rewrite 43 high-priority wiki pages Rewrites the most-visited configuration and authoring docs with: - Type annotations and defaults on every page - Markdown tables replacing HTML dl elements - Live examples using the js/html "example" annotation format - Accurate information sourced directly from the ReSpec source modules - Complete person object documentation - Full specStatus value tables with required fields - Structured linting rule pages with violation examples and fixes Pages rewritten: editors, specStatus, person, github, xref, caniuse, mdn, localBiblio, lint, data-cite, note, issue, example, data-dfn-type, data-lt, data-include, data-export, figure, shortName, group, data-dfn-for, preProcess, postProcess, authors, formerEditors, markdown, data-link-for, no-unused-dfns, local-refs-exist, no-http-props, wpt-tests-exist, data-sort, conformance, data-tests, appendix, informative, no-headingless-sections, license, addSectionLinks, edDraftURI, no-captionless-tables, logos, ednote

marcoscaceres committed Mar 27, 2026

Updated preProcess (markdown)

sidvishnoi committed Aug 6, 2025

add utils arg

sidvishnoi committed Apr 12, 2024

Drop bits on jQuery (no longer included in ReSpec)

tidoust committed Nov 25, 2020

spelling fixes

sidvishnoi committed Jul 8, 2020

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

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

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

sidvishnoi committed Jun 17, 2020

Added a note on the fact that the configuration object is available directly

iherman committed Mar 3, 2018

the these -> these

iherman committed Sep 7, 2016

Add preProcess

Marcos Cáceres committed Jun 27, 2016