added globalEvents flags json and documentation md file#45
added globalEvents flags json and documentation md file#45DetKewlDog wants to merge 10 commits intohelldivers-2:masterfrom
Conversation
|
Please modify jrd.tree to include the update file. I also recommend adding pages to your fork repo to test your changes to the documentation |
There was a problem hiding this comment.
I'm not entirely a fan of the name 'blank' for the workflow file, not particularly descriptive.
There was a problem hiding this comment.
Yeah i was trying to figure out gh pages, I'll delete it
| ## dictionary | ||
| This json contains a dictionary of key: value pairs, representing the globalEvent flag (which correlates to its type) returned from the Helldivers 2 Status API endpoint. | ||
|
|
||
| ```json |
There was a problem hiding this comment.
I would avoid copying the contents of globalEvents_flags here as any update to that file would also need to be made here.
Preferably link to the file itself to make maintenance easier
There was a problem hiding this comment.
Overall documentation could use work, it reads a little choppy still.
Try moving away from the 'dictionary' style of documentation and describe what global events are, point out which property indicates the global event, and in the example I'm missing what JSON you're showing (is this a planet, dispatch, ...)
|
@DetKewlDog how comes we closed this PR? |
|
Couldn't find the time to work on it and I didn't want it to stay open for no reason :( |
Figured this out using @jgaribsin 's
globalEventshistorical dump a while ago but I've noticed it's still not in this repo. Thought I might as well add it myself :)