This page contains the details of a technical writing project accepted for Season of Docs.
- Open source organization:
- Technical writer:
- Project name:
- Developing User Friendly GithHub Documentation for REST API
- Project length:
- Standard length (3 months)
The primary objective of the project is to develop an interactive documentation where end users can interact with API’s with try out options and in the meantime having more descriptive and self explained description which explains the technical and nontechnical people on what situation one should use the endpoint.
The current swagger environment is great but for non techies and techies still it’s harder to get an idea directly without proper documentation. The main idea would be getting this swagger environment and documentation in one place with nice representation. With the help of JS, HTML and CSS.