OpenAPITools / OpenAPITools/openapi-generator
[REQ][MARKDOWN] Option to rename the README.md file
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 main file output but the markdown generator is called README.md. If we want to host the docs as a github wiki the main file needs to be called Home.md. Therefore we need the option to provide a custom name for the main file.
Describe alternatives you've considered
We could just rename the file after generation but then we'd also have to search and replace the word README across all files to fix broken links.
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
Locate the markdown generator code that emits README.md and any related tests; start by tracing where the main output filename is set. Done means a configurable main-file name works for wiki output without broken links, with coverage for the custom name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100