Skip to content

Commit

Permalink
docs-ci: temporarily disable check-links for exact version usages in …
Browse files Browse the repository at this point in the history
…docs (FuelLabs#4948)

## Description
related to FuelLabs#4946.

Directly using `/latest` instead of exact versioning does not work for
some reason. To unblock bump PRs (one waiting, FuelLabs#4945) this PR disables
link checks at links which uses exact latest versions. We should find a
way to point to `latest` without using an exact version.
  • Loading branch information
kayagokalp authored Aug 14, 2023
1 parent c76f174 commit 254e50e
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Cargo

<!-- markdown-link-check-disable -->
Cargo can be used to install the Sway toolchain with various [`plugins`](https://fuellabs.github.io/sway/v0.43.2/book/forc/plugins/index.html).
<!-- markdown-link-check-enable -->

## Dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ The supported operating systems include Linux and macOS; however, Windows is [`u

`Cargo` may be used instead of [`Fuelup`](fuelup.md); however, the user needs to manage the toolchain themselves.

<!-- markdown-link-check-disable -->
The advantage of using `Cargo` is the installation of [`plugins`](https://fuellabs.github.io/sway/v0.43.2/book/forc/plugins/index.html) that have not been added into [`Fuelup`](fuelup.md).

The disadvantage occurs when [`Fuelup`](fuelup.md) and `Cargo` are used in tandem because the latest [`plugins`](https://fuellabs.github.io/sway/v0.43.2/book/forc/plugins/index.html) may not be recognized.
<!-- markdown-link-check-enable -->

## Source

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ The `Sway toolchain` can be built directly from the [`Sway repository`](https://

## Installation & Updating

<!-- markdown-link-check-disable -->
In the root of the repository `/sway/<here>` build [`forc`](https://fuellabs.github.io/sway/v0.43.2/book/forc/commands/index.html) with the following command:
<!-- markdown-link-check-enable -->

```bash
cargo build
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# The Sway Reference

<!-- markdown-link-check-disable -->
This is the technical reference for the Sway programming language. For a prose explanation and introduction to the language, please refer to the [Sway Book](https://fuellabs.github.io/sway/v0.43.2/book/).
<!-- markdown-link-check-enable -->

0 comments on commit 254e50e

Please sign in to comment.