Skip to content

History / Getting Started

Edit page New page

Revisions

  • docs: simplify examples; link specStatus to w3.org/standards/types - Getting-Started: drop <section id="conformance"> from minimal template (it's optional — ReSpec fills it only if present, never auto-generates it) - Editor's Guide complete example: drop plain <section><h2>A section</h2> that has no class/id/data attributes — it teaches nothing ReSpec-specific - specStatus: add link to https://www.w3.org/standards/types/ for normative W3C document type definitions

    @marcoscaceres marcoscaceres committed Mar 28, 2026
    a66d6ed

  • docs: rewrite Editor's Guide; consolidate Getting-Started The ReSpec Editor's Guide is the canonical getting started page. Getting-Started.md was a duplicate — now it's a minimal quick-start template with a pointer to the Editor's Guide. Editor's Guide changes: - Fix defer → async on ReSpec script tag - Add lang="en" to <html> in the full template - Add var-is-required explanation - Rewrite using live 'example' annotations throughout (was using screenshots) - Add note on URL query param config overrides - Modern examples throughout (async/await, template literals) - Consistent table format for shorthand syntax - Removed http:// URLs (was pointing to http://respec.org/xref/) - Expanded shorthands table to include [^element^], [[[SPEC#id]]] - Added TR/ publishing checklist - group replaces wg/wgId etc. — made explicit

    @marcoscaceres marcoscaceres committed Mar 28, 2026
    d46ecd6

  • fix: async not defer on ReSpec script tag Two examples had 'defer' on the ReSpec script element. The official example (examples/starter.html) uses 'async'. ReSpec itself handles DOMContentLoaded timing internally via domReady() so both work, but async is the canonical pattern.

    @marcoscaceres marcoscaceres committed Mar 28, 2026
    ea52396

  • 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