-
-
Notifications
You must be signed in to change notification settings - Fork 118
Season of Docs'20
Ignitus is working on its platform to automate the process of connecting students and professors, and to work collaboratively on the research projects, and it will need great documentation.
Goal: Make it easy for new users (technical and non-technical) to have more descriptive and self-explained descriptions.
The goal can be accomplished by:-
- Find examples and create How-tos, Walk-throughs, User-Guides, FAQs for Ignitus Client, and Backend.
- Identify technical documentation or improvement to technical documentation. Create a proposal that outlines how you would improve this area of technical documentation content.
- Create onboarding/quickstart documentation that new collaborators can use to guide them through the process of improving and creating technical documentation.
- Explain the current code structure, guidelines, and other details used in the current software.
- Explain the high-level goals, the architecture, the libraries used, the known limitations, and the high-level wishlist, write guidelines on how to implement the API to ensure a sound and safe user experience.
GitHub
-
You can find the Code guidelines and conventions in this repository: https://github.com/Ignitus/Ignitus-client/wiki/CodeGuidelines-And-Conventions
-
We plan to create documentation for the Ignitus platform which includes both these repositories. Ignitus-Client, Ignitus-Rest API
Mentors: Divyanshu Rawat and Afelio Padilla
Co-mentors: Paarmita Bhargava and Mayurs
Please feel free to reach out to us with questions. We like to work in the open and together with our community. contact us by using the following channels:
Email: [email protected], [email protected]
Slack: https://bit.ly/JoinIgnitusSlack.