Useless programmatic API docs
See original GitHub issue- Version: 21.2.0
- Target: Windows & Linux
Hello,
I have a VueJS app bundled with ParcelJS and I’d like to build it programmatically.
However, the programmatic API documentation doesn’t explain anything about how to do anything.
Here are the details :
- Parcel bundler transpiles into
./dist
- I’d like Electron Builder to compile
.appx
and.appimage
files into./release
- 64-bit only
Thanks
Issue Analytics
- State:
- Created 4 years ago
- Reactions:4
- Comments:40
Top Results From Across the Web
Are you a victim of terrible API documentation? : r/programming
We are all victims of bad documentation. On the other hand, technical writers are very often victims of bad API design.
Read more >Good API Documentation Is Not About Choosing the Right Tool
Building great API documentation depends on content just as much as software. Learn how Algolia approaches both for effective documentation.
Read more >ml-tooling/lazydocs: Generate markdown API ... - GitHub
Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx. - GitHub - ml-tooling/lazydocs: Generate markdown ...
Read more >Docs Navigation - Conductor API
The Conductor API provides secure, programmatic access to data in Conductor accounts. This API allows users to see the current configuration of their...
Read more >How to Use an API: Just the Basics 2022 | TechnologyAdvice
You'll need to check the API documentation to find out how to code these actions, as they're all different. API Calls. An API...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Well, I’m sorry for saying this but, if this work would have began two years ago, it would have been done by now.
For that I would have to already know which ones I need, but I don’t. However you can have a look at my original message to see what I need.
Would it be useful to create an issue for the
@description
tags so that it can be tackled bit by bit if someone has the will to do it, or at least do some functions.@mmaietta thanks for the example, I was in the process of adding one myself.