Skip to content

Commit

Permalink
Move help documentation into dedicated page (astral-sh#6057)
Browse files Browse the repository at this point in the history
  • Loading branch information
zanieb authored Aug 13, 2024
1 parent 037ba84 commit d203140
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 48 deletions.
5 changes: 3 additions & 2 deletions docs/getting-started/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,5 +100,6 @@ self-update:

## Next steps

Read the [guides](../guides/index.md) for an introduction to each feature or check out
[concept](../concepts/index.md) pages for in-depth details about uv's features.
Read the [guides](../guides/index.md) for an introduction to each feature, check out
[concept](../concepts/index.md) pages for in-depth details about uv's features, or learn how to
[get help](./help.md) if you run into any problems.
46 changes: 0 additions & 46 deletions docs/getting-started/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,52 +17,6 @@ You should see a help menu listing the available commands.
Read on for a brief overview of the help menu and version command, or jump to an
[overview of features](./features.md) to start using uv.

## Help menus

The `--help` flag can be used to view the help menu for a command, e.g., for `uv`:

```console
$ uv --help
```

To view the help menu for a specific command, e.g., for `uv init`:

```console
$ uv init --help
```

When using the `--help` flag, uv displays a condensed help menu. To view a longer help menu for a
command, use `uv help`:

```console
$ uv help
```

To view the long help menu for a specific command, e.g., for `uv init`:

```console
$ uv help init
```

When using the long help menu, uv will attempt to use `less` or `more` to "page" the output so it is
not all displayed at once. To exit the pager, press `q`.

## Viewing the version

To check the installed version:

```console
$ uv version
```

The following are also valid:

```console
$ uv --version # Same output as `uv version`
$ uv -V # Will not include the build commit and date
$ uv pip --version # Can be used with a subcommand
```

## Next steps

Now that you've confirmed uv is installed and know how to get help, check out an
Expand Down
61 changes: 61 additions & 0 deletions docs/getting-started/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Getting help

## Help menus

The `--help` flag can be used to view the help menu for a command, e.g., for `uv`:

```console
$ uv --help
```

To view the help menu for a specific command, e.g., for `uv init`:

```console
$ uv init --help
```

When using the `--help` flag, uv displays a condensed help menu. To view a longer help menu for a
command, use `uv help`:

```console
$ uv help
```

To view the long help menu for a specific command, e.g., for `uv init`:

```console
$ uv help init
```

When using the long help menu, uv will attempt to use `less` or `more` to "page" the output so it is
not all displayed at once. To exit the pager, press `q`.

## Viewing the version

When seeking help, it's important to determine the version of uv that you're using — sometimes the
problem is already solved in a newer version.

To check the installed version:

```console
$ uv version
```

The following are also valid:

```console
$ uv --version # Same output as `uv version`
$ uv -V # Will not include the build commit and date
$ uv pip --version # Can be used with a subcommand
```

## Open an issue on GitHub

The [issue tracker](https://github.com/astral-sh/uv/issues) on GitHub is a good place to report bugs
and request features. Make sure to search for similar issues first, as it is common for someone else
to encounter the same problem.

## Chat on Discord

Astral has a [Discord server](https://discord.com/invite/astral-sh), which is a great place to ask
questions, learn more about uv, and engage with other community members.
1 change: 1 addition & 0 deletions mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ nav:
- Installation: getting-started/installation.md
- First steps: getting-started/first-steps.md
- Features: getting-started/features.md
- Getting help: getting-started/help.md
- Guides:
- guides/index.md
- Installing Python: guides/install-python.md
Expand Down

0 comments on commit d203140

Please sign in to comment.