component-docs icon indicating copy to clipboard operation
component-docs copied to clipboard

[Umbrella issue] Restructuring the documentation

Open divya-mohan0209 opened this issue 7 months ago • 19 comments

This is a suggestion for restructuring the documentation based on the Divio paradigm

The TOC ends up looking as below

  • Introduction
  • Quickstart a.k.a. creating your very first component (This is the Tutorial section fleshed out a bit more with pre-requisites from the Language Support Section and also renamed)
  • Understanding the Component Model (Explanation)
    • Why the component model?
    • Components
    • Interfaces
    • WIT
    • Worlds
    • Packages
    • Canonical ABI
  • Using the Component Model (How to)
    • Creating and consuming components
      • Authoring components
      • Composing components
      • Running components
      • Distributing components
  • Reference documentation (Reference implementations of the Component Model)
  • Language support for components
    • Rust
    • Javascript
    • Python

divya-mohan0209 avatar Nov 21 '23 03:11 divya-mohan0209