OpenAPITools / OpenAPITools/openapi-generator
[REQ][MARKDOWN] Flat file structure
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
Currently the markdown files are sorted into subdirectories (Apis and Models). This does not work if we want to publish the docs as a github wiki since it doesn't support directories. Therefore I suggestion an option to use a flat file structure (all files in the same directory).
Describe alternatives you've considered
Manually moving files after generation and search and replace URL:s to remove the subdirectories, but this seems cumbersome and error prone.
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
Start by locating the Markdown generation path and the current Apis and Models subdirectories, then trace how generated URLs reference those paths. Done means an option can generate all Markdown files in one directory with links that work for a GitHub wiki.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100