swagger-api/swagger-codegen

Add auto-generated documentation

Open

#2,359 opened on Mar 11, 2016

View on GitHub
 (13 comments) (1 reaction) (0 assignees)HTML (5,474 forks)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We've add capabilities to generate documentation files (markdown) for API and model files in the Perl code generator: #2320, #2343

If anyone has cycle to add the documentation to the following languages, please reply to let us know:

Contributor guide

Research direction
Examine the existing documentation generation implementation for Perl (linked PRs) and implement similar for your chosen language from the list (Bash, C++, etc.). Ensure to update the code generator templates and add necessary tests.
Tech stack
java
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Clear
Prerequisites
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70