[svsm-devel] [RFC] Document Coconut-SVSM

[Jörg Rödel]

Hi Carlos,

On Tue, Aug 22, 2023 at 10:27:55AM -0500, Carlos Bilbao wrote:
> I just opened issue #74 on GitHub titled "Document COCONUT-SVSM" [1].
> Little explanation is needed, we should start this task while the project
> is in its early stages. I suggest we (1) Compile a list of critical
> components to document, potentially in order of importance and (2) Decide
> whether we'll use Rustdoc or consider other alternatives e.g. GitHub Wiki.

Good idea, thanks for bringing this up. I think rustdoc is the best
choice because keeps code and documentation close together.

As a starting point we can take a look at the submodules/directories in
the source and take this as the list of components.

Regards,

	Joerg