kshitij10496/hercules

Generate API documentation

Open

#45 opened on Nov 8, 2018

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (18 forks)auto 404
discussiondocumentationenhancementhelp wanted

Repository metrics

Stars
 (35 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We need to find a way to generate the API documentation.

Options:

Suggestions welcome!

Contributor guide

Research direction
Evaluate the suggested tool 'summerfish swagger' and others for generating API docs from Go code. Consider integration with the existing project structure.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60