Skip to content

Add docs for JSONRPC API. #4810

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

colinmollenhour
Copy link
Member

This adds documentation for the JSONRPC API.

It was generated using AI and I haven't read over every word but on first inspection it looks really solid. I don't know how to preview the docs offhand..

@sreichel
Copy link
Contributor

You have to install mkdocs,see https://docs.openmage.org/developers/mkdocs/

sreichel added a commit that referenced this pull request May 14, 2025
... fixed typo.

Spellcheck should work now for #4810
@colinmollenhour
Copy link
Member Author

You have to install mkdocs,see https://docs.openmage.org/developers/mkdocs/

Ahh, sorry, I should have found that.. was very short on time.. Anyway, I ran mkdocs locally and updated the main menu and skimmed through each page and fixed some formatting errors. I won't claim it's perfect but I think it's a whole lot better than nothing..

@sreichel
Copy link
Contributor

Thanks for working on it, :)

@sreichel sreichel added this to the 20.15.0 milestone May 16, 2025
empiricompany
empiricompany previously approved these changes May 16, 2025
@colinmollenhour
Copy link
Member Author

Spellcheck passed, thanks for the help.

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

Successfully merging this pull request may close these issues.

3 participants