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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃棐 Update Developer Documentation #479

Closed
zicklag opened this issue Nov 22, 2022 · 2 comments 路 Fixed by #817
Closed

馃棐 Update Developer Documentation #479

zicklag opened this issue Nov 22, 2022 · 2 comments 路 Fixed by #817
Assignees
Labels
topic:documentation Improvements or additions to documentation
Milestone

Comments

@zicklag
Copy link
Member

zicklag commented Nov 22, 2022

With the Bevy rewrite, most of the technical documentation has become out-of-date. We'll need some major documentation updates including:

  • An update to the book
    • We may want to remove most of the guide-level explanations initially, until we get a better handle on what the modding will look like.
  • An update to the developer-facing architecture docs
    • I think I want to leverage Rustdoc to as the center for most of our architecture documentation. That will make it easier to give in-depth, but contextual information on different game modules and how they fit together.
    • This will be the number-one place for you to learn about how the game is designed and what code you'll need to change to add/modify different features.
    • I'll want a large emphasis on well-documented modules and types so that it will really explain how the game is put together.
    • While this is absolutely still a work-in-progress game, we want to be able to point people to the source and it's documentation for what a "production ready" Rust game can look like in Bevy.
@zicklag zicklag added the topic:documentation Improvements or additions to documentation label Nov 22, 2022
@zicklag zicklag added this to the v0.5 milestone Nov 22, 2022
@zicklag zicklag self-assigned this Nov 22, 2022
@zicklag zicklag pinned this issue Nov 22, 2022
@zicklag zicklag modified the milestones: v0.5, Later Nov 22, 2022
@erlend-sh
Copy link
Member

Let鈥檚 rename the old book ff-legacy or whatever and leave it as it is. The new book at learn.fishfolk.org will incorporate your changes.

@erlend-sh erlend-sh modified the milestones: Later, v0.6 Jan 19, 2023
@zicklag zicklag modified the milestones: v0.6, v0.7 Feb 3, 2023
@zicklag zicklag modified the milestones: v0.7, 0.8 Apr 1, 2023
@zicklag
Copy link
Member Author

zicklag commented Jun 17, 2023

Progress update: ~11 days ago I got a lot of docs done for jumpy_core, though there's still more in there to flesh out.

If my time and health allows I'm going to try and finish this off soon-ish, trying to cover most of the modules and types with at least basic explanations.

zicklag added a commit that referenced this issue Jun 18, 2023
- improved main page and several modules.
- also move state enums into their own module for readability.

Works on: #479
@zicklag zicklag linked a pull request Jun 19, 2023 that will close this issue
@zicklag zicklag unpinned this issue Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants