Skip to content

Commit

Permalink
[#1968] Incorrect dropdown box for config in UG: Customizing Report (#…
Browse files Browse the repository at this point in the history
…2009)

There is a bug in the UG where the assets syntax is incorrectly
displayed under the config section instead of the correct config
syntax. This could potentially confuse users.

Let's fix the bug by displaying the correct config syntax, and add a
link to the page that explains the format of config files, for user
convenience.
  • Loading branch information
germainelee02 committed Jul 10, 2023
1 parent c84383f commit 95f97da
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/ug/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The section below provides explanations for each of the flags.

### `--assets`, `-a`

<div id="section-config">
<div id="section-assets">

**`--assets ASSETS_DIRECTORY`**: Specifies where to place assets for report generation.
* Parameter: `ASSETS_DIRECTORY` The directory containing the assets files. A `favicon.ico` file can be placed here to customize the favicon of the dashboard.
Expand Down Expand Up @@ -56,6 +56,7 @@ The section below provides explanations for each of the flags.

* Cannot be used with `--repos`. The `--repos` flag will take precedence over this flag.
* If both `--repos` and `--config` are not specified, RepoSense looks for config files in the `./config` directory.
* Config files must follow [this](./configFiles.html) format.
</box>
</div>

Expand Down

0 comments on commit 95f97da

Please sign in to comment.