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.

Sign up for GitHub

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

Jump to bottom

Write documentation #11

Open
aleokdev opened this issue Sep 25, 2021 · 1 comment
Open

Write documentation #11

aleokdev opened this issue Sep 25, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation
Projects
Pre Production

Comments

@aleokdev
Copy link
Collaborator

aleokdev commented Sep 25, 2021 •
edited
Loading

We need to write documentation for the project.

What solution should we use for documentation?
@aleokdev aleokdev added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 25, 2021
@karnkaul
Copy link
Collaborator

I'd prefer to stick to Doxygen-style docs, that way levk's docs will also contain these. I'd say this repo doesn't need its own docs build system, at least not until there's demand for it and usage of the lib beyond the two of us.

@aleokdev aleokdev changed the title What to use for documentation Write documentation Sep 30, 2021
@aleokdev aleokdev removed good first issue Good for newcomers help wanted Extra attention is needed labels Sep 30, 2021
@aleokdev aleokdev added this to To do in Pre Production Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Pre Production
To do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@karnkaul @aleokdev