bevyengine / bevyengine/bevy-website

Add info about how to write migration guides to contributor book

Open Beginner friendly
#2,567 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

Yesterday I wanted to write a migration guide for one of my PRs. I didn't know how to, so initially (naturally) I was looking at https://bevy.org/learn/contribute/introduction/. However there is no info about the migration guides creation there, so I had to ask on discord.

It would be nice to have a very brief section in either

- https://bevy.org/learn/contribute/helping-out/opening-pull-requests/
- https://bevy.org/learn/contribute/helping-out/writing-docs/

Contributor guide

Open the contributing guide

Research direction

Start with the contributor-book pages linked in the issue, especially Opening Pull Requests and Writing Docs, and compare their structure and guidance. Add a brief section explaining how to create migration guides in the most appropriate location, then check the rendered page to confirm the information is clear and accessible.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.