Skip to content

Documentation warnings #2576

Closed
Closed
@Hoidigan

Description

@Hoidigan

How can Bevy's documentation be improved?

There are various warnings when building documentation for the bevy crates.

Going through the list:
bevy_app:

  • FromResources does not exist (nor does it exist in any other crate, I believe). I think this one is from a refactoring to FromWorld.
  • WinitPlugin, DefaultPlugins, and MinimalPlugins are all missing because they are in different crates.

bevy_ecs:

  • broken links for Bundle::component_id (type of component_ids?)
  • broken link SystemParam (not imported, needs full path).

bevy_pbr and bevy_asset both have bare urls that should be surrounded with <>.
The urls are an easy fix (assuming we want to make them clickable?)

For the refactoring and typos, if that is what those are, that should be easy to fix as well.

The rest of the crates give no errors, so good there.

The different crate plugins are referenced from bevy_app, but are in bevy_internal, which poses an issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-DocsAn addition or correction to our documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions