Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add proof of concept docs site BM-917 #2990

Merged
merged 6 commits into from
Nov 6, 2023
Merged

Conversation

ajacombs
Copy link
Contributor

@ajacombs ajacombs commented Nov 3, 2023

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:

  • Add more documentation.
  • Improve the readability of the generated API docs (fix typographic hierarchy and character escaping issues).
  • Update the theme to match LINZ branding.

Checklist

  • Tests updated
  • Docs updated
  • Issue linked in Title

@ajacombs ajacombs requested a review from a team as a code owner November 3, 2023 03:26
.github/workflows/push.yml Outdated Show resolved Hide resolved
docs/User guide/README.md Outdated Show resolved Hide resolved
@ajacombs ajacombs added this pull request to the merge queue Nov 6, 2023
Merged via the queue into master with commit cabccc7 Nov 6, 2023
@ajacombs ajacombs deleted the wip/docs-generator branch November 6, 2023 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants