Skip to content

issue-28: Convert specifications into markdown#39

Merged
PkHutch merged 12 commits intodevelopmentfrom
issue-28
Feb 13, 2026
Merged

issue-28: Convert specifications into markdown#39
PkHutch merged 12 commits intodevelopmentfrom
issue-28

Conversation

@PkHutch
Copy link
Collaborator

@PkHutch PkHutch commented Jan 29, 2026

README.md edit was a little bit lax, but it doesn't seem like a good use of time currently
Fixes #28

Changes that are sneakily snuck in:

  • Created workflow to run on dev/test/prod branches for doc creation
  • Added pandoc for .md conversion
  • I did modify some things like we had vertical camera movement not as an additional feature, but as a base requirement
  • Simplified some of the wording where it was more verbose
  • Tidied up the reference list
  • Made Geo gender neutral, seemed more applicable
  • Turned the sounds section into a table
  • Small modifications to formatting as a result of the .md conversion

It's not a habit for me to do sneaky changes, but not doing so would have meant significant overhead to go through the document multiple times vs just the one time.

rileygramlich and others added 7 commits January 28, 2026 17:42
The first attempt at converting from the Google Doc file to the .md file
did not work very well. This is the manual cleanup. It also includes
some cleanup to the document itself.
.md file names are all caps by conventions.
Create a workflow so that the specifications will automatically get made
from the .md file for the .docx file.
sudonym-i
sudonym-i previously approved these changes Jan 29, 2026
Copy link
Collaborator

@sudonym-i sudonym-i left a comment

Choose a reason for hiding this comment

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

Looks good, one note:

Do you have a strong preference on where we place the SPECIFICATIONS.md file?

I generally prefer to only have files in root if they have a really good reason for being there, otherwise things sometimes get cluttered. Not a deal-breaker, just thought it was worth mentioning.

otherwise- LGTMIG

@PkHutch
Copy link
Collaborator Author

PkHutch commented Jan 29, 2026

Looks good, one note:

Do you have a strong preference on where we place the SPECIFICATIONS.md file?

I generally prefer to only have files in root if they have a really good reason for being there, otherwise things sometimes get cluttered. Not a deal-breaker, just thought it was worth mentioning.

otherwise- LGTMIG

I'm on board with this, also reminded me that I didn't remove the old specifications.docx or update the README.md with the hyperlinks.

Going to head home, resolve conflicts, restructure, update the lose ends.

Copy link
Collaborator

@emykh268 emykh268 left a comment

Choose a reason for hiding this comment

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

lgtm

@PkHutch PkHutch merged commit c52e0c0 into development Feb 13, 2026
1 check passed
@PkHutch PkHutch deleted the issue-28 branch February 13, 2026 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Convert Specifications into Markdown

4 participants

Comments