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

Add detailed wiki/documentation on examples, usage and the api #17

Open
agreco opened this issue Oct 16, 2019 · 1 comment
Open

Add detailed wiki/documentation on examples, usage and the api #17

agreco opened this issue Oct 16, 2019 · 1 comment

Comments

@agreco
Copy link
Owner

agreco commented Oct 16, 2019

As the title of this issue suggests, a detailed view on the purpose and usage of the project is required to enable users, i.e. me to understand the rationale and requirements to use and implement this project.

@agreco agreco changed the title Add detailed wiki/documentation on examples and usage Add detailed wiki/documentation on examples, usage and the api Oct 16, 2019
@agreco
Copy link
Owner Author

agreco commented Oct 16, 2019

Investigation into api documentation generation via TypeDoc reveals that the project could possibly use the generated output internally as opposed to a public facing reference.

Further investigation into theming is required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant