OpenAPITools / OpenAPITools/openapi-generator
Enhancement: Proper linting of Markdown documentation generated for client SDKs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
The markdown documentation generated for clients are not properly linted and cause problems with markdown based documentation generators i.e. docusaurus or docsify
openapi-generator version
4.0.0-beta2
Steps to reproduce
The issue could be reproduced by selectively generating Client SDK docs and using it inside a docs folder inside a Docsify/Docusaurus installation.
Related issues/PRs
None found. But a similar open issue exists in swagger-codegen.
Suggest a fix/enhancement
I've fixed the linting problems on Android, C#, Java, JavaScript, Go, Ruby-client, python and PHP
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 concerns Markdown documentation generated for client SDKs and reports problems when using it with Docsify or Docusaurus. Reproduce by selectively generating the Android, C#, Java, JavaScript, Go, Ruby, Python, and PHP client documentation and placing it in a Docsify or Docusaurus docs folder. Done means the generated documentation is properly linted and works with those documentation generators.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100