docs(website): fix the documentation for --include-path (#567)

* docs: fix the documentation for `--include-path` Related to #48 * style: update styling --------- Co-authored-by: Orhun Parmaksız <[email protected]>
orhun · Mar 22, 2024 · 4a7aa7e · 4a7aa7e
1 parent 172cae1
commit 4a7aa7e
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/website/docs/usage/monorepos.md b/website/docs/usage/monorepos.md
@@ -4,9 +4,16 @@ sidebar_position: 5
 
 # Monorepos
 
-You can generate a changelog scoped to a specific directory:
+You can generate a changelog scoped to a specific directory via `--include-path` and `--exclude-path`.
+
+This requires changing the current working directory to the target folder. The included/excluded paths must be relative to the repository's root.
+
+```bash
+cd packages/some_library
+git cliff --include-path "packages/some_library/**/*" --repository "../../"
+```
 
 ```bash
-git cliff --include-path "**/*.toml" --include-path "*.md"
-git cliff --exclude-path ".github/*"
+cd packages/some_library
+git cliff --include-path "packages/some_library/**/*" --repository "../../" --exclude-path ".github/*"
 ```