Skip to content

docs: enable strict mode for broken link checking #123

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

Merged
merged 1 commit into from
May 8, 2025
Merged

docs: enable strict mode for broken link checking #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ clean:
rm -rf site

# Serve docs site (unversioned, watches for changes)
serve: (_run "mkdocs serve -a 0.0.0.0:8000")
serve: (_run "mkdocs serve --strict -a 0.0.0.0:8000")

# List published versions
list: (_run "mike list -b publish")
Expand Down
2 changes: 1 addition & 1 deletion docs/install-upgrade/build-wiring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
A wiring diagram is a YAML file that is a digital representation of your
network. You can find more YAML level details in the User Guide section [switch
features and port naming](../user-guide/profiles.md) and the
[api](../reference/api.md). It's mandatory for all switches to reference a
[api](../reference/fabric-api.md). It's mandatory for all switches to reference a
`SwitchProfile` in the `spec.profile` of the `Switch` object. Only port naming
defined by switch profiles could be used in the wiring diagram, NOS (or any
other) port names aren't supported. An complete example wiring diagram is
Expand Down
4 changes: 3 additions & 1 deletion docs/install-upgrade/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ After the above workflow a user will have a .img file suitable for installing th

## Complete Example File

The following example outlines a comprehensive Fabricator configuration. You can find further configuration details in the Fabricator [API Reference](../../reference/include-fab-api/).
The following example outlines a comprehensive Fabricator configuration. You
can find further configuration details in the Fabricator [API
Reference](../reference/fab-api.md).

``` { .yaml .annotate title="fab.yaml" linenums="1"}
apiVersion: fabricator.githedgehog.com/v1beta1
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/shrink-expand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ how to manage connections between them.
Manipulating API objects is done with the assumption that target devices are correctly cabled and connected.

This article uses terms that can be found in the [Hedgehog Concepts](../concepts/overview.md), the [User
Guide](overview.md) documentation, and the [Fabric API](../reference/api.md) reference.
Guide](overview.md) documentation, and the [Fabric API](../reference/fabric-api.md) reference.

### Add a switch to the existing fabric

Expand Down
3 changes: 2 additions & 1 deletion docs/vlab/running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,8 @@ about managing the Fabric in the [Running Demo](demo.md) and [User Guide](../use
### Getting main Fabric objects

You can list the main Fabric objects by running `kubectl get` on the control node. You can find more details about
using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric API](../reference/api.md) and
using the Fabric in the [User Guide](../user-guide/overview.md), [Fabric
API](../reference/fabric-api.md) and
[Fabric CLI](../reference/cli.md) sections.

For example, to get the list of switches, run:
Expand Down