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 API #3

Open
Merseleo opened this issue Jan 20, 2025 · 0 comments · May be fixed by #13
Open

Document API #3

Merseleo opened this issue Jan 20, 2025 · 0 comments · May be fixed by #13
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Merseleo
Copy link
Contributor

At the moment only the most important (especially RPCs) or potentially ambiguous parts are documented.
To ensure a better overview and simplify familiarization with the project for other developers, however, the entire API should be well documented, i.e.

  • the RPCs, in particular the meaning of the parameters and the returns and what exactly the method does (especially if there are edge cases)
  • the messages and the meaning of the individual fields
  • a general description of the API, i.e. roughly which functionalities it offers for which roles, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants