Skip to content

Updating EDITING_DATA.md mainly with placeholder section titles#77

Merged
jules43 merged 11 commits intoSupraGamesCommunity:mainfrom
jules43:main
Apr 19, 2026
Merged

Updating EDITING_DATA.md mainly with placeholder section titles#77
jules43 merged 11 commits intoSupraGamesCommunity:mainfrom
jules43:main

Conversation

@jules43
Copy link
Copy Markdown
Collaborator

@jules43 jules43 commented Apr 17, 2026

This is mainly a test to make sure I've got the workflow down. Minor changes to the new document aimed at someone editing the data.

@jules43 jules43 requested a review from coverprice April 17, 2026 14:21
@jules43 jules43 self-assigned this Apr 17, 2026
Copy link
Copy Markdown
Collaborator

@coverprice coverprice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend splitting everything up like so:

CONTRIBUTING.md Guide to making any kind of contribution; i.e. how to fork, branch, pointers to the other docs with more specific instructions about frontend/backend changes, making a PR, expectations around code review, etc.

ARCHITECTURE.md Overview of how the codebase is laid out; not just the file structure, but how all the pieces fit together. This is to give the reader a mental model of the data, the code, and the processes. Also if there are any terms / jargon that needs to be defined, it can go here.

EDITING_DATA.md Step-by-step guides on performing specific tasks: e.g. Extracting the data from a specific game, adding a new Pin, updating a description, etc. This doc should just focus on the steps, and not be distracted by explaining any concepts; those should be covered by ARCHITECTURE.md.

jules43 added 10 commits April 18, 2026 14:55
- add version.json update for SW
- add running supraland_parser commands to export.cmd
- update supraland_parser to require source and data directories to be specified
- filter all marker types we're not interested in for SL/SLC/SIU
- remove actor targets handling
- relocate savedpadpipes.{game}.json
- updating localisation handling for SL/SLC/SIU
…g') is not the same as dict.get('flag') == False

Fixed bug in WiP cleanup of export commands
Always update version information when exporting map images or levels
Added command to do all "setup" steps in export
@jules43 jules43 merged commit c9c9498 into SupraGamesCommunity:main Apr 19, 2026
2 checks passed
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.

2 participants