search

holochain / holochain-client-js

A JavaScript client for the Holochain Conductor API
Other
259 stars 16 forks source link

[SPIKE] Suppress low-level or uninteresting interfaces and types in JS client documentation #293

Open pdaoust opened 4 hours ago

pdaoust commented 4 hours ago

There's a lot of stuff in the JS client documentation that's just TypeScript interfaces; e.g., https://github.com/holochain/holochain-client-js/blob/main/docs/client.adminapi.md . It's more meaningful to devs to interact with a concrete implementation like AdminWebsocket.

Alternatively, a boilerplate sentence could be added to all the uninteresting stuff to point people to a concrete implementation.

Question for @matthme : how does this impinge on things like Launcher? Does Launcher make a different implementation available? Will that be confusing for devs?

Addresses an issue found in #287 .

jost-s commented 3 hours ago

The woe with the api documenter package that's used is that as soon as you're exporting a type or interface, it needs to be @public or you make it @internal and need to put an underscore at the beginning. I agree it would be best to not generate docs for every little thing.

pdaoust commented 3 hours ago

blah, similar to woes with Rustdoc if I recall. Maybe it could be combined with #231 as a filter of some sort.