OpenAPITools / OpenAPITools/openapi-generator
[REQ] Generate single Markdown file
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
The generate markdown feature now output one readme file with many subfolders for apis, models which is only useful for github, awkward to use in every other cases.
As a sys admin, I want to integrate this tool in our pipelines, generate only one file for our readers to use easily/easier to transfer the generated documentation file between teams.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating the existing Markdown documentation generator and its command-line configuration, then determine how generated API and model content is assembled. Done means the generator can produce one transferable Markdown file rather than a README plus subfolders.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100