Updated data number (markdown)
a9696bd
Update worker example to reflect v37
aa64ad6
docs(shorthands): document [[[SPEC#id]]] cross-spec section links
2926a85
docs: add implementationStatus configuration option
Documents the new Baseline browser availability badge feature
(v37.0.0). Covers auto-detection, explicit feature IDs, the
removeOnSave option, multi-feature aggregation, and how to
find feature IDs on webstatus.dev.
5bd2fac
Updated data export (markdown)
303274f
isPreview: clarify prNumber/prUrl usage, fix code sample
Fixes speced/respec#4888
1c8fe1f
docs(shortName): note about latestVersion 404 before FPWD
Closes speced/respec#5101
8f47d5f
docs(shorthands): add global attribute syntax and xref search tip
Closes speced/respec#4466. Users couldn't find the syntax for global
HTML attributes. Added [^global/class^] example and a tip pointing
to the xref search tool.
e52319f
add `toHTML()` in export section
140ef73
docs(data-cite): document container scoping — data-cite on any element, not just <a>
52ab31b
docs(conformance): state RFC 2119 keyword requirement and ReSpec warning
3a2d79a
docs: fix data-abbr — document data-lt alias side-effect
The abbreviation is added to data-lt on the <dfn>, making it directly
linkable (e.g. [=UA=] after <dfn data-abbr>user agent</dfn>). The previous
note about "only affects first occurrence" was both incomplete and
misleading — removed it.
005ceaf
docs: update Shorthands, WebIDL guide, and tof
Shorthands-Guide.md:
- Add [[[SPEC#id]]] cross-spec section link syntax (just shipped in ReSpec)
- Fix dead heycam.github.io/webidl links → webidl.spec.whatwg.org
WebIDL-Guide.md:
- Fix dead heycam.github.io/webidl link → webidl.spec.whatwg.org
- Replace deprecated void return type with undefined
- Add constructor definition pattern (dfn constructor for=)
- Add enum value prose definition pattern (data-dfn-type="enum-value")
- Add dictionary member linking
- Add dfn type inference table for IDL members
- Add note about class="exclude" for IDL index
tof.md:
- Clarify that figures auto-get IDs from caption text; explicit id not required
aa7b8d4
docs: fix caniuse options; document conformance class="override"
- caniuse.md: remove maxAge (does not exist in source); add apiURL which
does exist for custom data endpoints
- conformance.md: document class="override" to suppress generated boilerplate
and write fully custom conformance text
1cd4a98
docs: add missing lint rules; fix highlightVars default and scope
- check-charset.md: new page for opt-in lint rule (missing/duplicate charset)
- check-internal-slots.md: new page for opt-in lint rule (missing . before [[slot]])
- lint.md: add check-charset and check-internal-slots; remove no-link-warnings
which is a CSS class, not a lint rule (already documented under CSS classes)
- highlightVars.md: fix default (true, not false); fix scope description
(nearest .algorithm or section, not just <ol>); document multi-color behavior
- _Sidebar.md: add check-charset and check-internal-slots to navigation
cb59a63
docs: fill documentation gaps found during spec authoring review
- warning.md: new page — class="warning" was completely undocumented
- issue.md: add class="atrisk" / Feature at Risk, atRiskBase, closed GitHub
issue state, inline <span class="issue"> support
- issueBase.md: rewrite with atRiskBase documented and clear linking semantics
- note.md: add class="warning" to variants table; document inline span support
- example.md: document auto-generated self-link on examples
- figure.md: fix wrong cross-reference (said no-captionless-tables, which is
for tables); document self-link; correct figcaption warning behavior
- idl-index.md: document class="exclude" to skip IDL blocks; clarify that
non-normative IDL is automatically excluded
- _Sidebar.md: add warning.md to navigation
aa6a8ce
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
a66d6ed
docs(lint): add no-dfn-in-abstract rule to lint table and create its page
ed10829
docs: document two footguns found during Dahut API live audit
data-export.md: warn against placing exported <dfn> in abstract or other
unnumbered sections — causes dfn-index crash (bug #5133, fixed in PR #5134).
group.md: add table showing which specStatus values are valid per group
type. CG groups (wicg etc.) require CG-DRAFT/CG-FINAL, not ED — a common
mistake that produces a confusing error with no prior warning in the docs.
deda0e5
docs(Writing-Algorithms): fix promise/Infra tables against spec source
Verified against webidl/index.bs and infra/infra.bs source files:
Promises (WebIDL):
- Add [=a promise resolved with=] (was missing entirely, line 8617 in
webidl/index.bs) — this is as common as 'rejected with'
- Add [=promise/react=] and [=wait for all=]
- Clarify 'resolved with' vs 'resolve': one creates a new already-
resolved promise, the other settles an existing pending promise
- Fix ordering: 'resolved with' before 'rejected with' for symmetry
Infra maps/lists:
- Fix [=map/exists=] → [=map/exist=] (canonical lt in infra.bs is
'exist|contain', not 'exists|contains')
- Add linking text column showing exact lt values
- Split map and list operations into separate tables
- Add missing operations: set, remove, for each, is empty
4f43f93
docs(Writing-Algorithms): add common patterns section
Adds six new subsections based on gaps found during the Dahut API
live docs audit:
- [=this=] — how to reference the current object in algorithm steps
- Promise patterns — [=a new promise=], [=resolve=], [=reject=],
[=a promise rejected with=], fulfillment/rejection hooks
- Parallel algorithms — [=In parallel=], [=Queue a task=],
[=Fire an event=] with xref context (HTML spec)
- Dictionary/map access — |options|['key'] [=map/exists=],
Infra map/list operations table
- Abort handling — standard pattern for AbortSignal support
- Enum values in prose — data-dfn-type='enum-value' + data-dfn-for
Also adds links to Infra and WebIDL in Tips section.
7e8b65e
docs: add var comment inline to code examples
The 'var is required' note now appears as a comment inside the code
block itself, so it's visible in the live rendered example — not just
as prose below it.
1968971
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.
2d49b69
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
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.
ea52396
fix(_Sidebar): fix 3 broken links + add new pages to navigation
Broken link fixes:
- lcEnd → removed (never existed as a page)
- data-sort-attribute → data-sort (correct page name)
- pre-code-elements → pre-and-code-elements (correct page name)
New entries added:
- Getting-Started and How-Do-I at top of Guides section
- Missing linting rules: no-captionless-tables, no-link-warnings
- Missing W3C options: prEnd, monetization
- Missing section IDs: tof
- Missing CSS classes: numbered, removeOnSave
- Missing attributes: data-export, data-max-toc (was under wrong heading)
- document.respec.version in special properties
- Clarified deprecated wg* options all replaced by group
5567eb3
docs: rewrite 25 more pages + fix document.respec.ready
Fixes:
- document.respec.md, respecIsReady.md, How-Do-I.md: property is
.ready not .isReady. Added .version property to document.respec docs.
New/rewritten config pages:
errata, references (section), additionalCopyrightHolders,
alternateFormats, copyrightStart, level, tocIntroductory (deprecated),
subjectPrefix, testSuiteURI, implementationReportURI,
submissionCommentNumber, charterDisclosureURI, updateable-rec,
prevRecShortname, prevED, prevRecURI, previousDiffURI,
addPatentNote (removed), override, permission, exclude, remove,
practice/practicedesc/practicelab, index (section), respecVersion
5a62bda
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.
cee41b6