bevy-website
bevy-website copied to clipboard
bevyengine
add linux dependency instructions and some placeholder headers
Decided to put the linux dependencies on the installation page but no reason they couldn't be on their own page if y'all want.
Mostly copied from bevyengine/docs/linux_dependencies.md but I added a Nix Flake.
this used to be in the book, but it was removed to keep only the file in the git repo because they weren't updated in sync.
why do you want to duplicate that information?
From my understanding, the intent is to move it from git to the book, migrating applicable documents from bevy/docs to the book.
Maybe we should delete it from bevy/docs to keep the info in one canon place. Although then it would be gone until the new book ships.
Maybe replace bevy/docs/linux_dependencies with a link which points to this file
Collapsible headings
html <details> seems to work fine. we might real collapsible headers (so they can be linked to with a fragment, etc.) someday:tm: but this will do for now.
this used to be in the book, but it was removed to keep only the file in the git repo because they weren't updated in sync.
Maybe we could consider creating a mechanism to #include files from the latest bevy release? This has come up a few times in the form of the config.toml, now dependencies, and I'm sure there are other fitting places; i.e. in-repo documentation such as bevy/docs/cargo_features.md
The plan is to move all of bevy/docs to bevy-website/learn/book. bevy/docs/cargo_features is next on my hit list.
as soon as this merges i'll make a mr replacing bevy/docs/linux_dependencies with a link to this (to avoid information duplication).
Some of these documents really require being kept in sync with main (cargo-features for instance), and the website just needs a checkpoint of what's on latest, so I'm not sure if moving them to the website repo is ideal
why do you want to duplicate that information?
Posting docs to the website will boost visibility and make it easier to on-board new users who maybe don't want to build the engine from source. It also just straight-up looks way more professional. I'm not suggesting we remove this from the repo, it's important we keep up-to-date install instructions for main. But what's the problem with duplication? Can't we just make sure this gets updated to be current every release (just like all the other docs on the website will have to be updated)?
Long term, I think we to should aim to have an install page like godot or rust or unity. This is like a tiny step in that direction, which I also like.
Yeah cargo features should probably be strongly coupled (although we disagree on how to do it). But I don't think this needs to be.