Skip to content

History / document.respec

Edit page New page

Revisions

  • 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 marcoscaceres committed Mar 28, 2026
    2d49b69

  • docs: fix document.respec.ready (not .isReady) The property is document.respec.ready, not document.respec.isReady. Fixed in: document.respec.md, respecIsReady.md, How-Do-I.md Also added document.respec.version property to document.respec.md.

    @marcoscaceres marcoscaceres committed Mar 28, 2026
    cee41b6

  • docs: rewrite 36 more pages; add Getting-Started and How-Do-I New pages: - Getting-Started.md — minimal template, local server, required config/sections - How-Do-I.md — task-oriented guide for common spec editor operations Rewritten config pages (with Type/Default headers and markdown tables): section, publishDate, previousPublishDate, previousMaturity, format, maxTocLevel, noTOC, subtitle, highlightVars, dark-mode, isPreview, modificationDate, otherLinks, latestVersion, canonicalURI, doJsonLd, dir, lang, pluralize, respecIsReady, document.respec, rs-changelog, gh-contributors, removeOnSave, monetization, crEnd, prEnd, noRecTrack Deprecated pages (migration guidance to group): wg, wgId, wgURI, wgPatentURI, wgPublicList Removed page: processVersion (removed in v19.5.0 — page updated to say so)

    @marcoscaceres marcoscaceres committed Mar 27, 2026
    256d859

  • s/isReady/ready

    @marcoscaceres marcoscaceres committed May 24, 2022
    af4407e

  • add custom heading ids

    @sidvishnoi sidvishnoi committed Nov 1, 2021
    e3c6cb8

  • Updated document.respec (markdown)

    @sidvishnoi sidvishnoi committed Oct 13, 2021
    0398836

  • Updated document.respec (markdown)

    @sidvishnoi sidvishnoi committed Oct 13, 2021
    abfe434

  • Created document.respec (markdown)

    @sidvishnoi sidvishnoi committed Oct 13, 2021
    ba94015