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

Rethink documentation #76

Closed
rstacruz opened this issue Dec 22, 2012 · 1 comment
Closed

Rethink documentation #76

rstacruz opened this issue Dec 22, 2012 · 1 comment

Comments

@rstacruz
Copy link
Member

I think it's a problem that the repository for documentation mina-docs isn't getting maintained well. I think it should be consolidated into the main mina repository.

Furthermore, I'm not sure how I feel about maintaining separate files for documentation, when there's lots of inline documentation. I'm neither for or against it, though I personally appreciate having both the convenient inline documentation and the ability to make detailed documentation, but maintenance of both are becoming a bit of a burden.

Ideas:

  1. Simply move mina-docs into the main repo. Pro: least work possible, Con: duplication of documentation with inline
  2. Rewrite documentation in Sphinx (example of a Sphinx-made documentation). Pro: we'll be using a more-supported tool. Con: the site will look different.
  3. Write a simple routine to extract inline code comments into separate pages.
@rstacruz
Copy link
Member Author

cc @mikong for ideas

@d4be4st d4be4st closed this as completed Jul 8, 2016
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