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

Properly document Zino #381

Open
lunkwill42 opened this issue Nov 7, 2024 · 0 comments
Open

Properly document Zino #381

lunkwill42 opened this issue Nov 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation post-zino2.0 These are features Zino1 does not have, but might be desired later

Comments

@lunkwill42
Copy link
Member

The legacy Zino state monitor has no public documentation that would aid new users in understanding what Zino is and what is design concepts are. Writing this type of documentation was never part of the original Zino 2.0 project specification - but it is nonetheless important if we want new users to be able to adopt Zino.

The best format for this documentation going forward with Zino 2 would be Sphinx documentation (i.e. mostly plain text / reStructured Text markup, or potentially markdown). The question is whether Håvard should be the one to begin the writing process, or if it should be more collaborative.

@lunkwill42 lunkwill42 added documentation Improvements or additions to documentation post-zino2.0 These are features Zino1 does not have, but might be desired later labels Nov 7, 2024
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 post-zino2.0 These are features Zino1 does not have, but might be desired later
Projects
Status: No status
Development

No branches or pull requests

1 participant