search

bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
193 stars 332 forks source link

Make website-specific information in Contributing Guide more discoverable #1606

Closed BD103 closed 1 month ago

BD103 commented 1 month ago

In #1605 a lot of great content from CONTRIBUTING.md is getting deleted, but without a great replacement in the Contributing Guide. A page or two should be added on details specific to the website, so this information isn't lost.

For starters, I would copy the content from CONTRIBUTING.md directly and make only modest changes. We can then follow-up in a different PR by moving around content or rewriting information as needed.

When this is done, I would also add a direct link from the new CONTRIBUTING.md for the website to the website-specific page in the Contributing Guide, so new contributors don't have to search to find it.

alice-i-cecile commented 1 month ago

We should probably do this before merging #1605.

BD103 commented 1 month ago

Turns out the website's CONTRIBUTING.md is migrated, as @TrialDragon pointed out:

All of the information in the current website CONTRIBUTING.md is already migrated to Writing Documentation → Documentation Source → The Website.

This should be made more discoverable, but it does exist.

BD103 commented 1 month ago

I'm going to close this; "more discoverable" is too generic a term. If finding the segment on contributing the website becomes a challenge, we can address it then.