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

Please create documentation about how to deal with demo.library #266

Open
kelson42 opened this issue Sep 25, 2024 · 2 comments
Open

Please create documentation about how to deal with demo.library #266

kelson42 opened this issue Sep 25, 2024 · 2 comments
Assignees

Comments

@kelson42
Copy link
Contributor

kelson42 commented Sep 25, 2024

In a README.md

Parta of the necessary doc is already available at https://wiki.openzim.org/wiki/Content_team#Demo_a_ZIM

@kelson42 kelson42 changed the title Please create documentation about how to deal with this tool Please create documentation about how to deal with demo.library Sep 25, 2024
@benoit74
Copy link
Collaborator

What is missing on https://wiki.openzim.org/wiki/Content_team#Demo_a_ZIM ? (I would like to avoid having multiple places where documentation is placed, and while I agree that architecture diagrams and details would help, this is true for the whole infrastructure and we've always considered we can live without it)

@benoit74
Copy link
Collaborator

benoit74 commented Oct 1, 2024

What is missing is an explanation of:

  • what is demo library
  • why we have it
  • how it works (for non-technical persons)

This should be placed in this repo in a README close to demo library, so that it will live with the code (contrary to the openZIM wiki which should hold only processes and not explanations about how software works)

@benoit74 benoit74 self-assigned this Oct 1, 2024
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

2 participants