OpenAPITools / OpenAPITools/openapi-generator
[BUG] Formatting issues in Typescript-Axios README.md
Open
Nobody has claimed this yet.
Issue: Bug
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Two minor issues in the typescript-axios generator that would make a better README.md:
- source: README.mustache
1.) Header should only have one # (better for auto-generating docs)
2.) Bottom of the file is missing a complete fenced code block causing bad markdown rendering.
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
Open modules/openapi-generator/src/main/resources/typescript-axios/README.mustache and inspect the heading and final fenced code block. Correct the Markdown formatting, then verify that the generated typescript-axios README has a single-level heading and a complete closing fence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100