search

Azure / autorest

OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
MIT License
4.63k stars 739 forks source link

Documentation website #4630

Open mongodben opened 2 years ago

mongodben commented 2 years ago

Is your feature request related to a problem? Please describe.

As a new user of autorest, I find the existing documentation hard to use because it is difficult/suboptimal to navigate between Markdown files in a Github repository.

Describe the solution you'd like

A public documentation website made using a documentation site builder like Docusaurus, Hugo, Gitbook, etc.

Describe alternatives you've considered

Migrate the docs to a Github wiki.

Additional context

i would be happy to help create this website. since the docs already exist within markdown files, i don't think it'd be too complex or time intensive.

timotheeguerin commented 2 years ago

Setting up Docusaurus would be really nice, not really going to have time to look into this soon but if you want to contribute to that that would be awesome!

mongodben commented 2 years ago

i'll try to look into/PR sometime soon.

(the PR might come from my personal Github account @bpmutter)