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

documentation directory ? #829

Closed
ghusson2 opened this issue Dec 9, 2015 · 4 comments
Closed

documentation directory ? #829

ghusson2 opened this issue Dec 9, 2015 · 4 comments
Assignees

Comments

@ghusson2
Copy link

ghusson2 commented Dec 9, 2015

As the project is rethinking the documentation, maybe it could be the right time for reorganization ?
For example a documentation directory with :
doc

  • file history (project history, hardware, persons involved)
  • file readme
  • file howto_begin
  • file howto_contribute (pull requests proposal, donate, official hardware maybe ?, CONTRIBUTING.md)
  • file official_faq (from unofficial FAQ :)
  • file links (with read further, blog tutorials and examples, ...)
  • dir examples (merge/reorganize example and lua_examples and lua_modules ?)
  • dir tutorial (maybe one day populated ?)
@marcelstoer
Copy link
Member

Will be part of #774 .

@ghusson2
Copy link
Author

ghusson2 commented Dec 9, 2015

Ok, i thought RTD was just in code markdown but it is a doc building system. I should move my comment to issue #774 and delete this issue #829 ?

@marcelstoer
Copy link
Member

You can leave it here. We can't fix all at once anyway and will work in small steps.

@marcelstoer
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants