bevyengine / bevyengine/bevy-website

Add Workspace Based Development to the Upcoming Bevy Book.

Open
#2,526 3 comments 6 reactions 0 assignees View on GitHub
A-Book C-Docs D-Modest
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

## How can Bevy's documentation be improved?

This issue is my submitting the idea of adding a workspace based workflow guide to the upcoming bevy book. Based on personal experience and those who have reached out to me I think this would be valuable.

If there is interest I would volunteer to write the section.

The section would roughly contain/recomend:
- Games start out as a single crate with a strong focus on bevy plugin hygiene.
- When compile times get annoying, then you break the game out into workspace crates along the lines of bevy plugins.
- General advice on how to handle Components or resources that may be used across plugins in a workspace based workflow.
- How to architect the workspace crates so maximal parallel compilation is achieved.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the upcoming Bevy Book's existing structure and identify where a workspace-based development guide belongs. The finished section should cover plugin hygiene, when to split a game into workspace crates, sharing components and resources, and structuring crates for parallel compilation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.