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

Create reference documentation #47

Open
axtloss opened this issue Apr 24, 2024 · 0 comments
Open

Create reference documentation #47

axtloss opened this issue Apr 24, 2024 · 0 comments
Assignees
@axtloss
Labels
documentation Improvements or additions to documentation

Comments

@axtloss
Copy link
Member

axtloss commented Apr 24, 2024

The documentation currently only consists of guides, a proper reference documentation that just explains every field in a recipe is missing.
This could potentially be automated, which would be more favourable than having to manually maintain them, I will be attempting to make a python script which generates the documentation automatically from the source
@axtloss axtloss added the documentation Improvements or additions to documentation label Apr 24, 2024
@axtloss axtloss self-assigned this Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@axtloss axtloss

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@axtloss