feat: Add proof of concept docs site BM-917 #2990
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
This adds an initial proof of concept of a documentation site. The documentation is generated from a combination of static Markdown documents; currently lightly modified from the existing files, plus a few placeholders.
API documentation is generated from the typescript source code using Typedoc. This is rendered to Markdown files using typedoc-plugin-markdown, which is combined with the static Markdown files to render the documentation site using MkDocs.
Modification
This is a rough proof of concept implementation, to be fleshed out in subsequent PRs which will:
Checklist