chore(readme): enhance warning

[realguse]

This PR enhances the README.md by replacing the old warning with a warning that looks nicer.

Before:

After:

[janhohenheim]

Don’t know if this readme is included in any of our docs, but if it is, this will trip up cargo doc, as it will parse it as a hyperlink FYI

[realguse]

This is just the deafult README.md with the "WARNING" message being replaced.

[janhohenheim]

I know :) You can do #![doc = include_str!("../README.md")] to include the readme in your rust docs, which lots of crates do. I don't think we do this anywhere in Bevy, but if we did, rust doc would not like the ![WARNING] syntax, as it would resolve to an incomplete link.

[realguse]

Could you give me the link to the docs where the README is present

[realguse]

I tested this on other markdown renderers, and there doesn't seem to be any other place than github that renders it.

[janhohenheim]

Sure! LWIM uses this technique:

• README
• doc include attribute
• docs.rs page showing the README

Yeah, GitHub is the only place that accepts the ![WARNING] etc. syntax, the other renderers will treat it as a simple (unresolved) link.

[realguse]

There seems to be some confusion here. This PR is for the README.md in this repo.

[janhohenheim]

As I said, I don't think Bevy includes the readme anywhere. LWIM is just an example of how it would look like if it did.
All I'm saying is that before merging this, we should make sure that the readme is never included anywhere as documentation.

[realguse]

Oh, i'm so sorry, ill see if i find anything.

[SludgePhD]

crates.io render the readme too: https://crates.io/crates/bevy

[MrGVSV]

I do like using these new annotations. They're prettier and easier on the eyes.

Assuming this README isn't used as documentation on docs.rs or any other renderer, I think we should be fine to use this.

Just a couple typos/suggestions.

[realguse]

I've gone ahead and fixed the type (>) and added the rust version warning back.

I tried to short it down, but let me know if i should use the original.

[realguse]

crates.io render the readme too: https://crates.io/crates/bevy

@SludgePhD, do you know if crates.io can render alerts?

[SludgePhD]

@SludgePhD, do you know if crates.io can render alerts?

I don't know, but they are a non-standard feature that isn't supported by most standard markdown engines, so if I had to guess I'd say no.

[realguse]

@SludgePhD, do you know if crates.io can render alerts?

I don't know, but they are a non-standard feature that isn't supported by most standard markdown engines, so if I had to guess I'd say no.

Is there any way of excluding it from the crates.io readme?

[SludgePhD]

I don't think so. The only thing you can do is to have two readmes, maybe one of them generated from the other to reduce duplication. Too much hassle for this minor change for sure. Or you could remove the crates.io readme entirely.

[janhohenheim]

Or set up the [WARNING] label to be a valid link, but idk what it would link to. Rick Roll? :p
Overall, I'm against merging this until we can make sure it does not break our crates.io presence.

[realguse]

The warning could link to the github readme, or (if its possibly) link to the warning alert in the github readme

[realguse]

the warning could link to a link like this (not rick roll btw)

https://arc.net/l/quote/bvslnemh

as you can see the warning gets highlighted

[realguse]

I tried linking to the higlitied text but it turned out like this:

[realguse]

Closed because of crates.io.