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

Consider documenting the gRPC client APIs #670

Open
rmfaheem opened this issue Jul 29, 2024 · 1 comment
Open

Consider documenting the gRPC client APIs #670

rmfaheem opened this issue Jul 29, 2024 · 1 comment

Comments

@rmfaheem
Copy link
Contributor

rmfaheem commented Jul 29, 2024

In the legacy docs, we had a complete documentation of the API of the legacy dotnet client. This type of documentation is immensely helpful to people who are just getting started with ESDB. We could consider adding this to the current docs as well.

@alexeyzimarev
Copy link
Member

The old docs were generated by DocFX, which can only do it for .NET. It also doesn't produce Markdown files by default, and those files it manages to produce often break the generator as "it wasn't designed to generate Markdown" (from a discussion in docfx repo). Each other language requires its own tooling to generate code API docs. It's quite a lot of work, I am not sure when we can do that. Although I agree it is useful.

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

No branches or pull requests

2 participants