Need documentation - Githubissues

sudz123 / Optimizer

C++ library for optimization problems

MIT License

12 stars 68 forks source link

Need documentation #74

Open sudz123 opened 6 years ago

sudz123 commented 6 years ago

Create a new folder in home which will hold the docs website
Add examples and create a documentation webpage, with html, css javascript files inside this folder

You can take reference from test.cpp The site could look like the Eigen documentation here

vinnyA3 commented 5 years ago

Can I take this one @sudz123 ? This seems like a really fun project! I want to help with the C++ portion as well, but I need some time to study / prepare before I start pushing any working C++ code.

sudz123 commented 5 years ago

Sure @vinnyA3 Go ahead. Take your time. I would say start with the basics first, with descriptions about the simplest algorithms. Work on this over multiple PRs, you can start with submitting one with a basic template html page in a folder in home. With each PR you submit, I can give you feed back and we can do this. Just be sure your code is well commented like Optimizer.h.

vinnyA3 commented 5 years ago

@sudz123 Updates: I had a working documentation site that I wanted to show you and gather your thoughts on! However, I decided to scrap it :/ I felt the project build infrastructure wasn't the best for the type of project--it was a bit more complex than it had to be; if someone else wanted to contribute, then it might be too difficult to get up and running. In addition, I felt the styles could be architected a bit better (for maximum reusability and maintainability). All being said, I am still going to stick with the same prototype design. I'll deliver soon! Happy hacking :)

sudz123 commented 5 years ago

Sure @vinnyA3 , I will trust your decision. Scalability and reusability are of utmost importance in this project. Once you submit a PR, I can comment more on this. All the best, happy hacking :)