Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pdaoust opened this issue Nov 14, 2024 · 2 comments

Comments

@pdaoust
Copy link

pdaoust commented Nov 14, 2024

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 .

@github-project-automation github-project-automation bot moved this to Backlog in Holochain Nov 14, 2024
@jost-s
Copy link
Contributor

jost-s commented Nov 14, 2024

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
Copy link
Author

pdaoust commented Nov 14, 2024

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

@jost-s jost-s moved this from Backlog to Ready for refinement in Holochain Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ready for refinement
Development

No branches or pull requests

2 participants