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

Add JSON schema parser to help auto-populate project documentation #140

Closed
osrsbox opened this issue Aug 15, 2019 · 0 comments

Comments

@osrsbox
Copy link
Owner

commented Aug 15, 2019

The JSON schema has invaluable information regarding the properties available for each item in the project, as well as if the property is mandatory, and the description of the property. This data is readily available and helping to populate documentation; for example, the osrsbox PyPi package README.md file. This will also be useful for future updates - such as the monster database (that is pretty much finished now!). This issue requires the following:

  • Update the items_schema.json file to have descriptions
  • Create a helpers script to parse the JSON schema and export to Markdown

@osrsbox osrsbox self-assigned this Aug 15, 2019

@osrsbox osrsbox closed this in 0ee7a5d Aug 19, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.