bevyengine / bevyengine/bevy-website

Add a bevy dependency graph to the contributor book (that stays up to date)

Open
#1,638 0 comments 1 reaction 0 assignees View on GitHub
A-Build-System A-Contributing-Guide C-Automation C-Content D-Modest S-Ready-For-Implementation
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

Using https://github.com/jplatte/cargo-depgraph, we can have the main bevy repo run a CI task on `main` whenever a new PR is merged that updates the dependency graph and stores it somewhere, then we simply link this standard location as an image in the contributor book.

This would help give a visual of the higher to lower level APIs and crates that bevy provides.

Contributor guide

Open the contributing guide

Research direction

Start by reading the contributor book structure and the existing CI workflows, then inspect how the main Bevy repository could run cargo-depgraph after merges. Done means the dependency graph is generated to a stable location and linked as an image in the contributor book, with later merged changes updating it automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.