Skip to content

Introduce API documentation#58

Merged
ScriptyChris merged 7 commits intodevelopfrom
maintenance/introduce-api-documentation
Jan 16, 2023
Merged

Introduce API documentation#58
ScriptyChris merged 7 commits intodevelopfrom
maintenance/introduce-api-documentation

Conversation

@ScriptyChris
Copy link
Copy Markdown
Owner

@ScriptyChris ScriptyChris commented Jan 14, 2023

  • add automatically generated API documentation via TypeDoc
  • update README.md file with lacking sections
  • fix Docker to make it to setup whole project from scratch

…debase - there are issues with documenting IIFEs and nested enums (redundancy has to be done to cover them) and TypeScript annotations are not picked up, hence some more TS aware docs generator has to be used instead;
@ScriptyChris ScriptyChris added the documentation Improvements or additions to documentation label Jan 14, 2023
@ScriptyChris ScriptyChris force-pushed the maintenance/introduce-api-documentation branch from d87ead2 to 1c3e920 Compare January 16, 2023 01:37
@ScriptyChris ScriptyChris merged commit aafbaa2 into develop Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant