Skip to content

Conversation

@jonasKjellerup
Copy link
Collaborator

@jonasKjellerup jonasKjellerup commented Nov 22, 2022

Brings updates to large parts of the documentation, as well as several additions.

  • Automated documentation generated based on ts-doc comments in the typescript code.
  • Updated style guide
  • Added setup guide
  • Added project structure overview

TODO:

  • Add API documentation from the docs branch to this as well.

There are still some changes that can be made to improve the auto-generated docs. However, these are internal changes in the documentation generator, and will be done in the extractor submodule (read: not in this repo).

  • Include non-exported items
  • Ensure that descriptions are outputted for non-type members

@jonasKjellerup jonasKjellerup added the a-meta Area: meta information, organisational changes, repository changes, etc. label Nov 22, 2022
@jonasKjellerup jonasKjellerup marked this pull request as draft November 22, 2022 22:06
@krestenlaust
Copy link
Member

What exactly do we need for this feature to be ready for merge?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a-meta Area: meta information, organisational changes, repository changes, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants