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

Sky Surge - add Troubleshooting.md to documentation #207

Merged

Conversation

MHLoppy
Copy link
Contributor

@MHLoppy MHLoppy commented May 16, 2024

Description

Myself and Castiel both had trouble running Sky Surge earlier during T1 2024 (even though we could run other games fine). We were both ultimately able to resolve our respective problems with some steps which I've thrown into a documentation file based on my own testing/research and the discussions I had with Castiel.

I'll look to mention documents like this in readmes later on in a separate PR (since the docs tend to get buried otherwise).

Type of change

  • Documentation (new)

How Has This Been Tested?

N/A

Testing Checklist

N/A

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I'll mark my work as ready for peer review

@MHLoppy MHLoppy marked this pull request as ready for review May 16, 2024 15:12
@github-actions github-actions bot added the compiled the source code has been successfully compiled label May 16, 2024
@MHLoppy
Copy link
Contributor Author

MHLoppy commented May 16, 2024

@DerDieDasDeakin
Copy link
Contributor

Great work identifying these issues and getting the documentation done! Sky Surge definitely is a bit more difficult to run and more temperamental when compared to the other arcade games, so this task was definitely needed. I think the task to update the ReadMe file is a great idea, especially since the current file acts more as a design document than a guide on how to actually get it running without errors. This was very much a needed task and I'm happy for this to be moved into mentor review.

@MHLoppy MHLoppy changed the title Add Troubleshooting.md to Sky Surge documentation Sky Surge - add Troubleshooting.md to documentation May 22, 2024
Copy link
Contributor

@CastielM CastielM 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! SkySurge could also do with a bug test/report done next tri if someone needs a task to ease them into things

@AmberPotion AmberPotion merged commit 091cbb1 into thoth-tech:main Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiled the source code has been successfully compiled
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants