Commit Graph

5 Commits

Author SHA1 Message Date
Will Jones 7d7e19fc38
Refer to MLCs as component providers ()
Component providers are those which implement the `Construct` endpoint
to supply remote components. Internally, we often refer to these as
"multi-language components", or MLCs, since historically this was the
point of introducing them -- to enable a program in any language to
consume a component written in any language. That said, "component
provider" is arguably a better term. Firstly, such providers may also
provide other non-component resources, and not "just" be "MLCs".
Secondly, "component providers" is the term we use when interacting with
customers, since it more effectively communicates the use case in
question. This commit reflects this preference by documenting component
providers, and not MLCs, in our developer documentation, fleshing out a
few things (such as local vs. remote) while we're at it.
2024-09-12 08:21:46 +00:00
Will Jones 593c483c7c
Document state and snapshots ()
This fills out the developer documentation on state and state snapshots.
As part of this we document the infamous class of snapshot integrity
errors, including possible causes and guidelines for avoiding and
debugging them.

Fixes 
2024-09-09 17:27:19 +00:00
Will Jones 07474caffc
Clarify some documentation around deployment execution () 2024-09-05 10:43:01 +00:00
Will Jones 7c78684084
Document providers and plugins ()
This commit stubs out developer documentation on the architecture and
implementation of plugins and, more specifically, resource providers.
Some sections are still incomplete but this is still more than we have
today and hopefully serves as a good starting point.
2024-09-05 09:25:16 +00:00
Will Jones ce1d6f6488
Flesh out architecture documentation ()
This commit ports over some of the old content from `developer-docs`.
While there we flesh out some bits, freshen up others by linking to our
newly-generated Protobuf documentation, and migrate the various diagrams
to Mermaid so that they can e.g. support zooming in the browser with D3.
2024-08-30 19:00:29 +00:00