-
Notifications
You must be signed in to change notification settings - Fork 85
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 JSON-RPC api #717
Comments
I'd say we need
as separate pages - as the protocol could change whilst "what it is and how to use it" should be more or less static. Then the "what it is and how to use it" would be linked from the client and server pages where it should get a simple mention. |
The link to the actual documentation should be JSON-RPC.md in the main repo under the docs/ folder |
Do we have texts for these already in jamulussoftware/jamulus#1975? I seem to recall we did, but where/are there two PRs? |
BTW I'm not qualified to write anything on this so I won't do it. But structure-wise, I agree we should just plonk in a brief "what it is, how to use it" into Software-Manual and Running-a-Server (I'd add a section after Command Line Options) and then put the hard docs into the repo .md. |
Just added a link on the cli page. Client and server admin manual should also have it mentioned. |
Moving to 3.9.1 -- the API isn't finalised as of 3.9.0 so documentation isn't pressing. |
Also there are things which need to be updated in the app: jamulussoftware/jamulus#2704 (comment) |
Bumping to 3.10.0. There are a few more bits that need doing for JSON-RPC. |
As soon as jamulussoftware/jamulus#1975 is merged, we need to link the JSON-RPC.md file somewhere from the website.
Where should the link be? Server admin? User manual? Tips and Tricks?
The text was updated successfully, but these errors were encountered: