autorest VS zeal

Doesn't autorest do that? https://github.com/Azure/autorest

The autorest project uses this actually.

It works by embedding yaml code blocks into a markdown file.

It’s actually not completely awful and has proven somewhat useful to have a configuration clearly documented within the config.

https://github.com/Azure/autorest/blob/main/docs/generate/re...

The StackQL Azure provider was created using the Autorest project using Azure specification docs from the azure-rest-api-specs repository. We will be adding integrated interactive authentication; for now, this is cli/sdk based; you can find all the documentation here.

I wonder if there is a format for API -> client automation that can be good enough, in the end Stripe have a rest API, with enough description it should be possible.

Okay so after a quick google it appears Microsoft are the "Simpsons already done it" of the programming world: https://github.com/Azure/autorest/

It'd probably be a good idea to add an Elixir backend for that and point it at Stripe's API here: https://github.com/stripe/openapi

It is definitely created with AutoRest. That's both its strength and its greatest weakness. :(

Honorable mentions: AutoRest, Visual Studio Connected Services

The Microsoft.Graph.* modules are AutoRest-generated modules. They are a straight wrapper around the REST calls that you would perform with Invoke-RestMethod or Invoke-WebRequest.

You can try autorest. I haven't used NSwag but I believe the two are similar. Also it looks like Nswag has a command line tool that you could use.

There's also Zeal (https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.

For offline tech documentation you can use Zeal. Must have tool for poor internet connection places. Present in ubuntu repos. https://zealdocs.org/

ads don't have to proprietary

here's one example of ads in FOSS https://github.com/zealdocs/zeal/issues/779

There’s stuff like https://zealdocs.org/ that allow you to take all relevant documentation with you so offline coding will work.

If you just want to be productive, you could also bring a lot of books or downloaded tutorials on a drive.

Btw, make sure your drive is encrypted and you think of a way to backup your data so you don’t lose the offline progress.

I’d suggest you look into Kiwix¹ and also Zeal².

1. https://www.kiwix.org/

2. https://zealdocs.org/

For offline documentation, I use Zeal (called Dash on macos) which looks/works almost identically to rubydoc.info but much faster since it's offline, has a standard interface for all installed language documentations, and only 1 global hotkey away while programming.

I highly recommend using local solutions to this local issue: Zeal[1] (aka Dash[2] on MacOS)

Load up the "docsets" of your languages (lightly edited HTML docs for indexing purposes) and use a global keyboard shortcut (F8 for me) to pull up Python/Postgres/Terraform docs, searching for the right function without internet query.

This isn't straight up applicable to all questions of course, but "How do I search regular expressions in Python again?" is now as easy as "re"

Note that the docsets can be converted from normal HTML ones via doc2dash[3], especially useful to load up custom docs like private providers.

[1]: https://zealdocs.org/