Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add user-facing documentation for web functionality #204

Closed
TimJentzsch opened this issue Dec 27, 2024 · 2 comments · Fixed by #223
Closed

Add user-facing documentation for web functionality #204

TimJentzsch opened this issue Dec 27, 2024 · 2 comments · Fixed by #223
Assignees
@TimJentzsch
Labels
A-Web Building or running Bevy apps targeting the browser C-Docs An improvement in documentation X-Uncontroversial This work is generally agreed upon
Milestone
`bevy_cli` 0.1.0

Comments

@TimJentzsch
Copy link
Collaborator

We need better user-facing docs for the bevy build web and bevy run web commands.
On one hand, to make them more discoverable, on the other hand, to be able to go into more detail than the single line --help docs allow.

The documentation could reside in docs.rs or the README.
It would also be interesting to investigate if clap offers a way to provide more detailed documentation to the user if they ask for it, so they can look up everything on the fly as well.
@TimJentzsch TimJentzsch added C-Docs An improvement in documentation X-Uncontroversial This work is generally agreed upon A-Web Building or running Bevy apps targeting the browser labels Dec 27, 2024
@BD103

This comment has been minimized.

Sign in to view
@TimJentzsch
Copy link
Collaborator Author

Sorry, maybe the issue description wasn't clear enough.
I was refering to the CLI features, not the cargo feature flags

@TimJentzsch TimJentzsch added this to the `bevy_cli` 0.1.0 milestone Dec 27, 2024
@BD103 BD103 mentioned this issue Dec 27, 2024
Merged
@TimJentzsch TimJentzsch changed the title Add user-facing documentation for web features Add user-facing documentation for web functionality Jan 2, 2025
@TimJentzsch TimJentzsch mentioned this issue Jan 12, 2025
Merged
@TimJentzsch TimJentzsch self-assigned this Jan 12, 2025
TimJentzsch added a commit that referenced this issue Jan 13, 2025
@TimJentzsch
Add documentation for web commands to README (#223)
6702a64 
# Objective

Closes #204.

It's currently hard for users to discover how to use the web-specific
functionality of the CLI.
As a first step, we should expand the README to give an overview of the
provided features.

# Solution

- Add installation instructions
- Add an overview of the main features and configuration options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TimJentzsch TimJentzsch

Labels
A-Web Building or running Bevy apps targeting the browser C-Docs An improvement in documentation X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
`bevy_cli` 0.1.0
Development

Successfully merging a pull request may close this issue.

Add documentation for web commands to README TheBevyFlock/bevy_cli
2 participants
@TimJentzsch @BD103