Skip to content

Commit fb99bcb

Browse files
Point users towards the documentation (#244)
* Point users to docs instead of this spec * Link to docs from explainer
1 parent f3002fe commit fb99bcb

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Component Model design and specification
22

3+
This repository is where the component model is being standardized. For a more user-focussed explanation, take a look at the **[Component Model Documentation]**.
4+
35
This repository describes the high-level [goals], [use cases], [design choices]
4-
and [FAQ] of the component model as well as a more-detailed [explainer], [IDL],
6+
and [FAQ] of the component model as well as a more-detailed [assembly-level explainer], [IDL],
57
[binary format] and [ABI] covering the initial Minimum Viable Product (MVP)
68
release.
79

@@ -21,12 +23,12 @@ All Component Model work is done as part of the [W3C WebAssembly Community Group
2123
To contribute to any of these repositories, see the Community Group's
2224
[Contributing Guidelines].
2325

24-
26+
[Component Model Documentation]: https://component-model.bytecodealliance.org/
2527
[goals]: design/high-level/Goals.md
2628
[use cases]: design/high-level/UseCases.md
2729
[design choices]: design/high-level/Choices.md
2830
[FAQ]: design/high-level/FAQ.md
29-
[explainer]: design/mvp/Explainer.md
31+
[assembly-level explainer]: design/mvp/Explainer.md
3032
[IDL]: design/mvp/WIT.md
3133
[binary format]: design/mvp/Binary.md
3234
[ABI]: design/mvp/CanonicalABI.md

design/mvp/Explainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This explainer walks through the assembly-level definition of a
44
[component](../high-level) and the proposed embedding of components into
5-
native JavaScript runtimes.
5+
native JavaScript runtimes. For a more user-focussed explanation, take a look at the **[Component Model Documentation](https://component-model.bytecodealliance.org/)**.
66

77
* [Grammar](#grammar)
88
* [Component definitions](#component-definitions)

0 commit comments

Comments
 (0)