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

Generate documentation for Ignitus :) #151

Closed
divyanshu-rawat opened this issue Oct 28, 2018 · 4 comments
Closed

Generate documentation for Ignitus :) #151

divyanshu-rawat opened this issue Oct 28, 2018 · 4 comments
Assignees
Labels
enhancement New feature or improvement of existing feature. hacktoberfest Fest to promote open source software development. help wanted Extra attention is needed. TODO Something that i spending but needs to be done soon.

Comments

@divyanshu-rawat
Copy link
Member

Is your feature request related to a problem? Please describe.
There's no doubt that project documentation is a vital part of project management. It is substantiated by the essential two functions of documentation: to make sure that project requirements are fulfilled and to establish traceability with regard to what has been done, who has done it, and when it has been done

Describe the solution you'd like
Use https://www.docz.site/ for the same.

Additional context
Using Docz's built-in components makes it easy to document your things. Using the power of components and AST parsing algorithms to source data, Docz renders your components on the fly, generates fully-formatted property tables, provides custom search, and so much more. The sky is the limit!

@divyanshu-rawat divyanshu-rawat added enhancement New feature or improvement of existing feature. help wanted Extra attention is needed. TODO Something that i spending but needs to be done soon. labels Oct 28, 2018
@debck
Copy link
Member

debck commented Oct 28, 2018

thanks @divyanshu-rawat Can you please tell the subtopics that need to be included (or some documentation example ). I had never written any project documentation before 😄

@divyanshu-rawat
Copy link
Member Author

@debck It generates it automatically I guess feel free to give it a try :) Let's see.
You can include subtopics as per your choices 👍

@divyanshu-rawat
Copy link
Member Author

@debck maybe you can also use your documentation experience here as well - https://docs.google.com/presentation/d/1ABqCc5uAoQv9aqGCxmNqOJ9S_Tst-adNV3fcWQ2Quwc/edit#slide=id.g42b115f18c_0_0

@divyanshu-rawat
Copy link
Member Author

and for more info. refer this youtube tutorial 👍

@divyanshu-rawat divyanshu-rawat added the hacktoberfest Fest to promote open source software development. label Nov 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement of existing feature. hacktoberfest Fest to promote open source software development. help wanted Extra attention is needed. TODO Something that i spending but needs to be done soon.
Projects
None yet
Development

No branches or pull requests

3 participants