swagger-api / swagger-api/swagger-client
Table of content is not in project's readme.md
Open
@Towbee05 is already working on this.
Since Nov 15, 2025.
- Dominant language
- JavaScript
- Stars
- 2.7k
- Forks
- 765
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
Content & configuration
Swagger/OpenAPI definition:
# your YAML here
Swagger-Client usage:
SwaggerClient({
// your config options here
})
Is your feature request related to a problem?
There is no table of content in the project's main readme.md file. This should be there to help easily navigate the readme.md file.
I also noticed a "mistake" in the "runtime" section of the readme file. It was not treated as a proper section.
Describe the solution you'd like
Adding a table of contents to the readme.md file makes reading it more convenient as navigating to required section becomes easier.
Describe alternatives you've considered
I will create a pull request adding the table of contents within the readme file
Additional context
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.
Assessment
This issue has not been assessed yet.