diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 3213021136..ec8f71dd41 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -77,7 +77,7 @@ jobs: chmod +x cmd/carapace/carapace sed -i 's/\[output.linkcheck\]/#[output.linkcheck]/' docs/book.toml sh .github/completers.sh > docs/src/completers.md - sh .github/macros.sh > docs/src/specs/macros.md + sh .github/macros.sh > docs/src/spec/macros.md mdbook build docs sh .github/badge.sh > docs/book/badge.svg sh .github/macros-badge.sh > docs/book/macros-badge.svg diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index ef1d38a770..31c43bd8ed 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -6,9 +6,9 @@ - [Completers](./completers.md) - [Bridge](./bridge.md) - [Style](./style.md) - - [Specs](./specs.md) - - [Examples](./specs/examples.md) - - [Macros](./specs/macros.md) + - [Spec](./spec.md) + - [Examples](./spec/examples.md) + - [Macros](./spec/macros.md) - [Development](./development.md) - [Build](./development/build.md) - [docker-compose](./development/docker-compose.md) diff --git a/docs/src/specs.md b/docs/src/spec.md similarity index 99% rename from docs/src/specs.md rename to docs/src/spec.md index ecefcaaedc..e5313b91aa 100644 --- a/docs/src/specs.md +++ b/docs/src/spec.md @@ -1,4 +1,4 @@ -# Specs +# Spec Custom completions can be defined using [yaml specs](https://github.com/rsteube/carapace-spec). diff --git a/docs/src/specs/examples.md b/docs/src/spec/examples.md similarity index 100% rename from docs/src/specs/examples.md rename to docs/src/spec/examples.md diff --git a/docs/src/specs/macros.md b/docs/src/spec/macros.md similarity index 100% rename from docs/src/specs/macros.md rename to docs/src/spec/macros.md