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

[DOCS] Generate an initial documentation page #76

Open
darigovresearch opened this issue Apr 2, 2021 · 2 comments
Open

[DOCS] Generate an initial documentation page #76

darigovresearch opened this issue Apr 2, 2021 · 2 comments

Comments

@darigovresearch
Copy link

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
Copy link
Author

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:

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?

@lquenti
Copy link

lquenti commented Dec 16, 2022

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

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