-
Notifications
You must be signed in to change notification settings - Fork 2k
Documentation Guidelines
WebKit maintains three official documentation surfaces. This document defines the purpose, audience, and ownership of each surface, and provides selection criteria to help contributors place new content in the correct location.
At a glance: GitHub Wiki = how we work · docs.webkit.org = how WebKit works · webkit.org = what WebKit is
| Property | webkit.org | docs.webkit.org | GitHub Wiki |
|---|---|---|---|
| Purpose | Public-facing project surface | Canonical technical reference | Operational knowledge |
| Primary audience | Web developers, community, external stakeholders | WebKit engineers and integrators | Active contributors |
| Content type | News, project policy, feature and standards status, community resources | Architecture, design documents, contribution overview | Workflows, coding guidelines, port-specific notes, frequently-changing content |
| Update process | Pull request + review | Pull request + peer review | Direct edit by trusted contributors |
| Stability | Curated and editorial | Stable and versioned | Living and informal |
When deciding where to publish new content, evaluate the following questions in order. Stop at the first affirmative answer.
-
Is the content public-facing? Is it intended for web developers, the broader community, or does it convey project-level policy? → Publish on webkit.org
-
Is the content stable reference material? Does it describe architecture, design decisions, or contribution overview that engineers will cite long-term? → Publish on docs.webkit.org
-
Is the content operational? Does it describe an internal workflow, coding convention, or process that changes frequently? → Publish on the GitHub Wiki
If none of the criteria above clearly apply, default to the GitHub Wiki. Wiki content carries the lowest publication overhead and can be migrated to docs.webkit.org once it stabilizes into reference material.