diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b2ab1d5..85067f0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -68,6 +68,6 @@ Describe externally observable behavior (state transitions, event ordering, timi ## Spec/Crosswalk Review (required for W3C-aligned behavior changes) -- [ ] Reviewed `documents\crosswalk\webrtcnet-api-to-spec.md` -- [ ] Reviewed `documents\specs\index\spec-map.md` +- [ ] Reviewed `docs\standards\crosswalk\webrtcnet-api-to-spec.md` +- [ ] Reviewed `docs\standards\specs\index\spec-map.md` - [ ] Refreshed/checked local spec snapshots (`.\scripts\update-spec-docs.ps1`) when needed diff --git a/.github/skills/w3c-specs/SKILL.md b/.github/skills/w3c-specs/SKILL.md index 8474395..d835f4a 100644 --- a/.github/skills/w3c-specs/SKILL.md +++ b/.github/skills/w3c-specs/SKILL.md @@ -1,6 +1,6 @@ --- name: w3c-specs -description: Reviews WebRtcNet's local W3C spec corpus and produces implementation guidance with citations. Use when the user asks to compare or validate WebRtcNet.Api behavior against local spec files, requests gap analysis, or wants chunk-focused standards review using documents/specs and documents/crosswalk. +description: Reviews WebRtcNet's local W3C spec corpus and produces implementation guidance with citations. Use when the user asks to compare or validate WebRtcNet.Api behavior against local spec files, requests gap analysis, or wants chunk-focused standards review using docs/standards/specs and docs/standards/crosswalk. --- # W3C Specs @@ -19,9 +19,9 @@ Example input: ## Workflow 1. Read local sources first, in this order: - 1. `documents/specs/index/spec-map.md` (or `.json`) - 2. `documents/crosswalk/webrtcnet-api-to-spec.md` - 3. Relevant TR snapshots in `documents/specs/**/TR-*.html` + 1. `docs/standards/specs/index/spec-map.md` (or `.json`) + 2. `docs/standards/crosswalk/webrtcnet-api-to-spec.md` + 3. Relevant TR snapshots in `docs/standards/specs/**/TR-*.html` 4. Relevant summaries and `*-idl.webidl` files 2. Restrict analysis to the requested focus area. 3. Map findings to concrete repository targets (`WebRtcNet.Api/**`, tests, docs) when requested. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8e33fe..db51ec7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,9 +23,9 @@ PR descriptions for behavioral changes **MUST** include: For `WebRtcNet.Api` behavior changes, PRs **MUST** also update or validate: -- `documents\specs\index\spec-map.json` (canonical API symbol to spec anchor map) -- `documents\specs\index\spec-map.md` (human-readable mirror) -- `documents\crosswalk\webrtcnet-api-to-spec.md` (implementation status/adaptation notes) +- `docs\standards\specs\index\spec-map.json` (canonical API symbol to spec anchor map) +- `docs\standards\specs\index\spec-map.md` (human-readable mirror) +- `docs\standards\crosswalk\webrtcnet-api-to-spec.md` (implementation status/adaptation notes) ## 3. Test gates by change area diff --git a/README.md b/README.md index 4028b6f..f2871ab 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ See [WebRTC 1.0: Real-time Communication Between Browsers](https://www.w3.org/TR ## Local W3C spec corpus -This repository keeps a local standards corpus in `documents\specs\` to support standards-alignment work in `WebRtcNet.Api` without repeated web fetching. +This repository keeps a local standards corpus in `docs\standards\specs\` to support standards-alignment work in `WebRtcNet.Api` without repeated web fetching. - Canonical snapshots: `TR-*.html` - Copilot-friendly artifacts: `*-summary.md`, `*-idl.webidl`, and `specs\index\spec-map.*` -- API mapping: `documents\crosswalk\webrtcnet-api-to-spec.md` +- API mapping: `docs\standards\crosswalk\webrtcnet-api-to-spec.md` Refresh with: diff --git a/WebRtcNet.Api/Media/MediaStreamTrack.cs b/WebRtcNet.Api/Media/MediaStreamTrack.cs index fcf7908..449cbd5 100644 --- a/WebRtcNet.Api/Media/MediaStreamTrack.cs +++ b/WebRtcNet.Api/Media/MediaStreamTrack.cs @@ -176,10 +176,12 @@ public abstract class MediaStreamTrack /// /// Required constraints (for example exact, min, and max) participate in acceptance checks. /// Advanced sets are evaluated in the order supplied and may be skipped when unsatisfied without failing the entire apply. - /// Local reference: documents/specs/mediacapture/mediacapture-idl.webidl - /// (MediaStreamTrack.applyConstraints, MediaTrackConstraintSet, and MediaTrackConstraints.advanced). + /// See the published W3C definitions for applyConstraints, + /// MediaTrackConstraintSet, and MediaTrackConstraints.advanced. /// /// + /// + /// /// /// Constraints to apply, or to clear constraints. public abstract void ApplyConstraints(MediaTrackConstraints? constraints = null); diff --git a/WebRtcNet.Api/Media/MediaTrackConstraintSet.cs b/WebRtcNet.Api/Media/MediaTrackConstraintSet.cs index fba4360..3100ffe 100644 --- a/WebRtcNet.Api/Media/MediaTrackConstraintSet.cs +++ b/WebRtcNet.Api/Media/MediaTrackConstraintSet.cs @@ -147,9 +147,11 @@ public class MediaTrackConstraintSet /// Gets whether this set contains any required constraints (for example exact, min, or max). /// /// - /// Local reference: documents/specs/mediacapture/mediacapture-idl.webidl - /// (MediaTrackConstraintSet and Constrain* definitions). + /// See the published W3C definitions for MediaTrackConstraintSet and + /// Constrain* dictionary members. /// + /// + /// public bool HasRequiredConstraints => (Width?.IsRequired ?? false) || (Height?.IsRequired ?? false) || diff --git a/WebRtcNet.Api/Media/MediaTrackConstraints.cs b/WebRtcNet.Api/Media/MediaTrackConstraints.cs index 8eb97ab..5c0dd9c 100644 --- a/WebRtcNet.Api/Media/MediaTrackConstraints.cs +++ b/WebRtcNet.Api/Media/MediaTrackConstraints.cs @@ -16,9 +16,8 @@ public partial class MediaTrackConstraints : MediaTrackConstraintSet /// /// /// This corresponds to MediaTrackConstraints.advanced in the specification. - /// Local reference: documents/specs/mediacapture/mediacapture-idl.webidl - /// (MediaTrackConstraints, MediaTrackConstraintSet, and - /// MediaStreamTrack.applyConstraints(optional MediaTrackConstraints constraints = {})). + /// See the published W3C definitions for MediaTrackConstraints, + /// MediaTrackConstraintSet, and MediaStreamTrack.applyConstraints. /// /// /// @@ -44,9 +43,11 @@ public IList? Advanced /// Enumerates constraints in processing order: base set first, then entries in list order. /// /// - /// Local reference: documents/specs/mediacapture/mediacapture-idl.webidl - /// (MediaTrackConstraints and MediaTrackConstraints.advanced sequence ordering). + /// See the published W3C definitions for MediaTrackConstraints and + /// MediaTrackConstraints.advanced sequence ordering. /// + /// + /// public IEnumerable EnumerateConstraintSetsInProcessingOrder() { yield return this; diff --git a/documents/README.md b/docs/standards/README.md similarity index 98% rename from documents/README.md rename to docs/standards/README.md index 1c564b9..b32ac3b 100644 --- a/documents/README.md +++ b/docs/standards/README.md @@ -1,4 +1,4 @@ -# Documents +# Standards This folder contains repository-local reference material used to support standards-alignment work in `WebRtcNet.Api`. diff --git a/documents/crosswalk/README.md b/docs/standards/crosswalk/README.md similarity index 100% rename from documents/crosswalk/README.md rename to docs/standards/crosswalk/README.md diff --git a/documents/crosswalk/webrtcnet-api-to-spec.md b/docs/standards/crosswalk/webrtcnet-api-to-spec.md similarity index 98% rename from documents/crosswalk/webrtcnet-api-to-spec.md rename to docs/standards/crosswalk/webrtcnet-api-to-spec.md index 37858c5..611ae1c 100644 --- a/documents/crosswalk/webrtcnet-api-to-spec.md +++ b/docs/standards/crosswalk/webrtcnet-api-to-spec.md @@ -6,7 +6,7 @@ This crosswalk maps high-value `WebRtcNet.Api` symbols to current W3C specificat Source-of-truth note: -- `documents\specs\index\spec-map.json` is the canonical API symbol to spec anchor map. +- `docs\standards\specs\index\spec-map.json` is the canonical API symbol to spec anchor map. - This crosswalk adds implementation status, adaptation notes, and priority guidance. ## WebRTC 1.0 diff --git a/documents/specs/README.md b/docs/standards/specs/README.md similarity index 100% rename from documents/specs/README.md rename to docs/standards/specs/README.md diff --git a/documents/specs/index/README.md b/docs/standards/specs/index/README.md similarity index 84% rename from documents/specs/index/README.md rename to docs/standards/specs/index/README.md index ab67dc6..5283a94 100644 --- a/documents/specs/index/README.md +++ b/docs/standards/specs/index/README.md @@ -12,7 +12,7 @@ Canonical files: - `spec-map.json` is the source of truth for API symbol to W3C anchor mapping. - `spec-map.md` should be kept in sync with `spec-map.json`. -- `documents\crosswalk\webrtcnet-api-to-spec.md` captures implementation status and adaptation notes. +- `docs\standards\crosswalk\webrtcnet-api-to-spec.md` captures implementation status and adaptation notes. ## Status vocabulary diff --git a/documents/specs/index/spec-map.json b/docs/standards/specs/index/spec-map.json similarity index 100% rename from documents/specs/index/spec-map.json rename to docs/standards/specs/index/spec-map.json diff --git a/documents/specs/index/spec-map.md b/docs/standards/specs/index/spec-map.md similarity index 100% rename from documents/specs/index/spec-map.md rename to docs/standards/specs/index/spec-map.md diff --git a/documents/specs/index/update-log.md b/docs/standards/specs/index/update-log.md similarity index 100% rename from documents/specs/index/update-log.md rename to docs/standards/specs/index/update-log.md diff --git a/documents/specs/licenses/NOTICE.md b/docs/standards/specs/licenses/NOTICE.md similarity index 100% rename from documents/specs/licenses/NOTICE.md rename to docs/standards/specs/licenses/NOTICE.md diff --git a/documents/specs/licenses/README.md b/docs/standards/specs/licenses/README.md similarity index 100% rename from documents/specs/licenses/README.md rename to docs/standards/specs/licenses/README.md diff --git a/documents/specs/licenses/w3c-document-license-2023.html b/docs/standards/specs/licenses/w3c-document-license-2023.html similarity index 100% rename from documents/specs/licenses/w3c-document-license-2023.html rename to docs/standards/specs/licenses/w3c-document-license-2023.html diff --git a/documents/specs/licenses/w3c-software-license-2023.html b/docs/standards/specs/licenses/w3c-software-license-2023.html similarity index 100% rename from documents/specs/licenses/w3c-software-license-2023.html rename to docs/standards/specs/licenses/w3c-software-license-2023.html diff --git a/documents/specs/mediacapture/README.md b/docs/standards/specs/mediacapture/README.md similarity index 100% rename from documents/specs/mediacapture/README.md rename to docs/standards/specs/mediacapture/README.md diff --git a/documents/specs/mediacapture/TR-mediacapture-streams.html b/docs/standards/specs/mediacapture/TR-mediacapture-streams.html similarity index 100% rename from documents/specs/mediacapture/TR-mediacapture-streams.html rename to docs/standards/specs/mediacapture/TR-mediacapture-streams.html diff --git a/documents/specs/mediacapture/mediacapture-idl.webidl b/docs/standards/specs/mediacapture/mediacapture-idl.webidl similarity index 100% rename from documents/specs/mediacapture/mediacapture-idl.webidl rename to docs/standards/specs/mediacapture/mediacapture-idl.webidl diff --git a/documents/specs/mediacapture/mediacapture-summary.md b/docs/standards/specs/mediacapture/mediacapture-summary.md similarity index 100% rename from documents/specs/mediacapture/mediacapture-summary.md rename to docs/standards/specs/mediacapture/mediacapture-summary.md diff --git a/documents/specs/webrtc-stats/README.md b/docs/standards/specs/webrtc-stats/README.md similarity index 100% rename from documents/specs/webrtc-stats/README.md rename to docs/standards/specs/webrtc-stats/README.md diff --git a/documents/specs/webrtc-stats/TR-webrtc-stats.html b/docs/standards/specs/webrtc-stats/TR-webrtc-stats.html similarity index 100% rename from documents/specs/webrtc-stats/TR-webrtc-stats.html rename to docs/standards/specs/webrtc-stats/TR-webrtc-stats.html diff --git a/documents/specs/webrtc-stats/webrtc-stats-idl.webidl b/docs/standards/specs/webrtc-stats/webrtc-stats-idl.webidl similarity index 100% rename from documents/specs/webrtc-stats/webrtc-stats-idl.webidl rename to docs/standards/specs/webrtc-stats/webrtc-stats-idl.webidl diff --git a/documents/specs/webrtc-stats/webrtc-stats-summary.md b/docs/standards/specs/webrtc-stats/webrtc-stats-summary.md similarity index 100% rename from documents/specs/webrtc-stats/webrtc-stats-summary.md rename to docs/standards/specs/webrtc-stats/webrtc-stats-summary.md diff --git a/documents/specs/webrtc/README.md b/docs/standards/specs/webrtc/README.md similarity index 100% rename from documents/specs/webrtc/README.md rename to docs/standards/specs/webrtc/README.md diff --git a/documents/specs/webrtc/TR-webrtc.html b/docs/standards/specs/webrtc/TR-webrtc.html similarity index 100% rename from documents/specs/webrtc/TR-webrtc.html rename to docs/standards/specs/webrtc/TR-webrtc.html diff --git a/documents/specs/webrtc/webrtc-idl.webidl b/docs/standards/specs/webrtc/webrtc-idl.webidl similarity index 100% rename from documents/specs/webrtc/webrtc-idl.webidl rename to docs/standards/specs/webrtc/webrtc-idl.webidl diff --git a/documents/specs/webrtc/webrtc-summary.md b/docs/standards/specs/webrtc/webrtc-summary.md similarity index 100% rename from documents/specs/webrtc/webrtc-summary.md rename to docs/standards/specs/webrtc/webrtc-summary.md diff --git a/scripts/update-spec-docs.ps1 b/scripts/update-spec-docs.ps1 index 1cf9ea0..2dd9375 100644 --- a/scripts/update-spec-docs.ps1 +++ b/scripts/update-spec-docs.ps1 @@ -36,7 +36,7 @@ function Get-Hash { return (Get-FileHash -Algorithm SHA256 -Path $FilePath).Hash } -$specRoot = Join-Path $RepoRoot "documents\specs" +$specRoot = Join-Path $RepoRoot "docs\standards\specs" $indexLog = Join-Path $specRoot "index\update-log.md" $downloads = @(