Track: Learning

[tigleym]

We aim to make contributions to Fish Fight a positive experience for new contributors. Part of this effort is to provide documentation and resources for learning.

Currently, we are looking to consolidate all learning material into one place for new contributors and we've begun doing this using mdBook, which is hosted at https://fishfight.github.io/FishFight/.

This is still a WIP and there are a number of tasks that can already be worked on (those without a linked issue will be filed shortly):

• Update contributing guidelines for Fish Fight code #227 (assigned to @tigleym)
• Rendering the README.md file in the book (assigned to @tigleym)
• Rendering the CODE_OF_CONDUCT.md file in the book (assigned to @tigleym)
• Simple Gun Weapon Section Updates #253 (@cdsupina)
• Fish Fight version of ‘Platformer Book’ #88 (assigned to @cdsupina )
• [Proposal] Add a CI job for enforcing consistent formatting for markdown files #228
• Create a page for the "How to draw a weapon the Fish Fight way" document #233
• Documentation for adding new items
• Add a chapter for the editor (assigned to @tigleym)

This isn't an exhaustive list and we welcome anyone to file new issues that belong on this track! This can include:

• Fixing typos and/or grammatical errors
• Updating information that may be outdated/incorrect
• New book pages
• Other ideas for learning materials

[zicklag]

For any potential contributors finding this issue:

We are currently undergoing a big rewrite of Jumpy to use the Bevy game engine:

• Bevy Rewrite #466

Until that is finished, we aren't ready for any extra docs. Once that's done, we will be updating docs to match the new architecture and will probably open to new tutorials, etc.