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

Document Go client APIs #2802

Open
sipsma opened this issue Apr 12, 2022 · 0 comments
Open

Document Go client APIs #2802

sipsma opened this issue Apr 12, 2022 · 0 comments
Assignees
Milestone

Comments

@sipsma
Copy link
Collaborator

sipsma commented Apr 12, 2022

Right now both the LLB and gateway client libraries are essentially undocumented, with new users having to look at examples (in the Buildkit repo and elsewhere) or just the underlying implementation to know how to use them.

I think at a bare minimum it would be good to add docs in the code for these interfaces. More examples and/or guides would be good too, especially for the LLB client library.

Also, something like "integrator docs" that explains what the terms LLB, gateway, frontend, etc. would be good too to help those who are trying to create higher-level tools using Buildkit get started in the first place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants