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 initial project documentation #152

Merged
merged 4 commits into from
Oct 30, 2024
Merged

Add initial project documentation #152

merged 4 commits into from
Oct 30, 2024

Conversation

afritzler
Copy link
Member

@afritzler afritzler commented Oct 29, 2024

Proposed Changes

Add an intial project documentation based on mkdocs-material.

You can run the rendered version locally via:

make startdocs

Fixes #62

Initial version and tooling setup for the project documentation.
@github-actions github-actions bot added size/XL documentation Improvements or additions to documentation enhancement New feature or request labels Oct 29, 2024
@afritzler afritzler merged commit 7e909ce into main Oct 30, 2024
8 checks passed
@afritzler afritzler deleted the enh/docs branch October 30, 2024 08:11
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 enhancement New feature or request size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add concept document describing API types
1 participant