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

Update JSON_INFO.md #72434

Merged
merged 2 commits into from
Mar 23, 2024
Merged

Update JSON_INFO.md #72434

merged 2 commits into from
Mar 23, 2024

Conversation

RedMisao
Copy link
Contributor

Summary

None

Purpose of change

Document missing stuff related to Professions, such as the recipes and spells fields, what "Hobbies" are, and the "Professions group" type. The "Professions" section can also be improved by using a block example describing what each field does and how it can be used.

Describe the solution

Update the professions section of the doc:

  1. Added a block example for profession, with examples of every field that can be used. This is for the sake of clarity as it's more clear (I believe) and compact
  2. Added the missing fields of recipe (added back in Professions can start with specific recipes #68818, which I found by chance) and spells (no idea when this was added)
  3. Added a subsection for "Hobbies", under "Professions", with a block example
  4. Added a subsection for "Profession groups", also under "Professions", explaining what it is and how it's used
  5. Cleaned the Index

Describe alternatives you've considered

Testing

Additional context

  1. Couldn't find an example of hobbies nor whitelist_hobbies usage anywhere, so I did not add it to the example
  2. I noticed that while the doc is organized by our (contributors) work, it contains mismatch of formats and there's stuff that has been moved elsewhere or it's obsolete.
    This requires a further clean up of this doc, maybe addding a standard style/guide in JSON_STYLE.md. The former requires a lot of work given JSON_INFO.md is +6k lines and most of that can be standarized.

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions <Bugfix> This is a fix for a bug (or closes open issue) <Enhancement / Feature> New features, or enhancements on existing Code: Infrastructure / Style / Static Analysis Code internal infrastructure and style Info / User Interface Game - player communication, menus, etc. BasicBuildPassed This PR builds correctly, label assigned by github actions labels Mar 16, 2024
@Maleclypse Maleclypse merged commit 7368abd into CleverRaven:master Mar 23, 2024
16 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions <Bugfix> This is a fix for a bug (or closes open issue) Code: Infrastructure / Style / Static Analysis Code internal infrastructure and style <Documentation> Design documents, internal info, guides and help. <Enhancement / Feature> New features, or enhancements on existing Info / User Interface Game - player communication, menus, etc. json-styled JSON lint passed, label assigned by github actions [Markdown] Markdown issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants