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

Adopt a Documentation Generator for use with Moja Global #123

Open
HarshCasper opened this issue Jan 23, 2021 · 5 comments
Open

Adopt a Documentation Generator for use with Moja Global #123

HarshCasper opened this issue Jan 23, 2021 · 5 comments
Labels
P0 High priority issue

Comments

@HarshCasper
Copy link
Member

Is your feature request related to a problem? Please describe.

Currently, I have not found the usage of Documentation Generator Tools in usage at Moja Global. Right now all the Documentation is hosted on the Moja Global Docs and Wiki Tabs.

Describe the solution you'd like

We can make use of a Documentation Generator like Doxygen which can automatically generate apt documentation for us by going through the Source Code and publishing the output using PDF/HTML.

According to the Official Docs of Doxygen, we can consider the following advantages for our case:

  • Helps track Document revision history and versioning.
  • Generate online documentation browser even from undocumented code.
  • Brings a centralized knowledge base to help new contributors to get started.
  • Helps new contributors to get started up.

Describe alternatives you've considered

One popular alternative that we can consider is Breathe which supposedly acts as a bridge between the Sphinx and Doxygen documentation systems. Since we are already using Sphinx, it would be quite reasonable to consider Breathe as well.

Additional context

@HarshCasper
Copy link
Member Author

cc: @aornugent @gmajan

@gmajan
Copy link
Member

gmajan commented Jan 24, 2021

@sabitarao

@sarthakkundra
Copy link
Collaborator

@HarshCasper Can I close this?

@HarshCasper
Copy link
Member Author

@HarshCasper Can I close this?

As of now its a different issue, out of scope for the GSoD Project. Let's keep it open and revisit it after sometime.

@stale
Copy link

stale bot commented Jul 1, 2021

Hi,
Thanks for raising an issue! We at moja global appreciate your concerns and views to help us improve. We capitalize on fostering a welcoming environment for all our contributors.
This issue has not seen any activity for the past 30 days. If this Issue would not see any further updates in the next 7 days, it would be automatically closed. Please comment on the issue if you would like to discuss on this further.
We truly appreciate your contributions and would love to hear your thoughts on the same!

@stale stale bot added the wontfix label Jul 1, 2021
@HarshCasper HarshCasper added P0 High priority issue and removed wontfix labels Jul 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 High priority issue
Projects
None yet
Development

No branches or pull requests

3 participants