genanki icon indicating copy to clipboard operation
genanki copied to clipboard

[DOCS] Generate an initial documentation page

Open darigovresearch opened this issue 3 years ago • 2 comments

Following the discussion on issue #74 thought it would be good to open a specific issue on generating documentation in case the community had any thoughts on what the best docs format would be and to see if anyone would like to contribute in making one.

darigovresearch avatar Apr 02 '21 10:04 darigovresearch

This would help make the project more accessible for new joiners and help pull from a wider audience for new features etc. Would suggest having it in the same repository if possible so it could be hosted as a GitHub page

For context here are some example docs frameworks that can be used:

  • Read the docs - https://readthedocs.org/
  • Docusaurus - https://docusaurus.io/
  • docsy - https://www.docsy.dev/docs/

Examples of open source documentation based on some of the above frameworks Open source pick and place machine - https://docs.indexmachines.io/docs/ Open source machines to recycle plastic - https://community.preciousplastic.com/academy/intro.html

Do any of the maintainers have a documentation framework they have a preference for?

darigovresearch avatar May 15 '21 10:05 darigovresearch

Even more interesting, is there anywhere else where the .apkg format is fomally defined?

lquenti avatar Dec 16 '22 12:12 lquenti