From e9078ddfc5cf766dee8ab1054b911d204af73170 Mon Sep 17 00:00:00 2001 From: Marek Kaput Date: Tue, 8 Aug 2023 11:04:48 +0200 Subject: [PATCH] Update links to contain `.html` suffix --- ARCHITECTURE.md | 6 +++--- MAINTAINING.md | 4 ++-- README.md | 6 +++--- examples/cairo_run_example/Scarb.toml | 2 +- examples/hello_world/Scarb.toml | 2 +- examples/starknet_hello_world/Scarb.toml | 2 +- examples/starknet_multiple_contracts/Scarb.toml | 2 +- extensions/scarb-cairo-language-server/README.md | 2 +- install.sh | 2 +- scarb-metadata/README.md | 2 +- scarb-metadata/src/lib.rs | 2 +- scarb/src/core/package/name.rs | 3 ++- scarb/src/ops/new.rs | 2 +- 13 files changed, 19 insertions(+), 18 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 31e80c98d..bf5fcac80 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -256,7 +256,7 @@ When building a project, Scarb retrieves appropriate compiler implementation fro The compiler will later be used to compile the project into the target output. ### Compilation units -Please see [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/compilation-model) for more information. +Please see [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/compilation-model.html) for more information. ### CairoPluginRepository @@ -286,13 +286,13 @@ Cairo compiler relies on the `RootDatabase` for management of the compilation st When compiling a single compilation unit, Scarb creates and configures the database, and passes it to the Cairo compiler. The compilation of each unit uses a separate database instance, which is then dropped after the compilation is finished. The database is initialized with Cairo project configuration, obtained from the Scarb compilation unit, conditional -compilation parameters (see [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/conditional-compilation) +compilation parameters (see [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/conditional-compilation.html) for more information) and active Cairo plugins. ### Profiles implementation Profiles provide a way to alter the compiler settings from the Scarb manifest file. -Please see the [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/profiles) for general information +Please see the [scarb documentation](https://docs.swmansion.com/scarb/docs/reference/profiles.html) for general information about profile use cases and syntax. Overrides imposed by profile definition are applied towards the appropriate settings while converting `TomlManifest` diff --git a/MAINTAINING.md b/MAINTAINING.md index b7cf18a20..53cf08721 100644 --- a/MAINTAINING.md +++ b/MAINTAINING.md @@ -106,7 +106,7 @@ Happy to announce that Scarb vX.Y.Z is live! 🔥 blahblah 🚀 even more blahblah -Go check it out: https://docs.swmansion.com/scarb/download +Go check it out: https://docs.swmansion.com/scarb/download.html Release notes: https://github.com/software-mansion/scarb/releases/tag/vX.Y.Z @swmansionxyz @StarkWareLtd @@ -130,7 +130,7 @@ Announcing Scarb vX.Y.Z! 🔥 blahblah 🚀 even more blahblah -Download: https://docs.swmansion.com/scarb/download +Download: https://docs.swmansion.com/scarb/download.html Release notes: https://github.com/software-mansion/scarb/releases/tag/vX.Y.Z Tweet: https://twitter.com/... ``` diff --git a/README.md b/README.md index 833310d2b..0e9a6b9ac 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ Scarb manages your dependencies, compiles your projects and works as an extensib All information about Scarb is available on project's [website](https://docs.swmansion.com/scarb/). -* [Installation](https://docs.swmansion.com/scarb/download) -* [Cheat sheet](https://docs.swmansion.com/scarb/docs/cheatsheet) -* [Documentation](https://docs.swmansion.com/scarb/docs) +* [Installation](https://docs.swmansion.com/scarb/download.html) +* [Cheat sheet](https://docs.swmansion.com/scarb/docs/cheatsheet.html) +* [Documentation](https://docs.swmansion.com/scarb/docs.html) ## Changelog diff --git a/examples/cairo_run_example/Scarb.toml b/examples/cairo_run_example/Scarb.toml index 7c160cc67..ecc603a84 100644 --- a/examples/cairo_run_example/Scarb.toml +++ b/examples/cairo_run_example/Scarb.toml @@ -2,7 +2,7 @@ name = "cairo_run_example" version = "0.1.0" -# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest +# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html [dependencies] # foo = { path = "vendor/foo" } diff --git a/examples/hello_world/Scarb.toml b/examples/hello_world/Scarb.toml index 163d4228b..0a7292a21 100644 --- a/examples/hello_world/Scarb.toml +++ b/examples/hello_world/Scarb.toml @@ -2,7 +2,7 @@ name = "hello_world" version = "0.1.0" -# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest +# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html [dependencies] # foo = { path = "vendor/foo" } diff --git a/examples/starknet_hello_world/Scarb.toml b/examples/starknet_hello_world/Scarb.toml index c1610477c..a30ad7161 100644 --- a/examples/starknet_hello_world/Scarb.toml +++ b/examples/starknet_hello_world/Scarb.toml @@ -2,7 +2,7 @@ name = "starknet_hello_world" version = "0.1.0" -# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest +# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html [dependencies] starknet = "2.1.0" diff --git a/examples/starknet_multiple_contracts/Scarb.toml b/examples/starknet_multiple_contracts/Scarb.toml index e632a0ff2..ab1d29e09 100644 --- a/examples/starknet_multiple_contracts/Scarb.toml +++ b/examples/starknet_multiple_contracts/Scarb.toml @@ -2,7 +2,7 @@ name = "starknet_multiple_contracts" version = "0.1.0" -# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest +# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html [dependencies] starknet = "2.1.0" diff --git a/extensions/scarb-cairo-language-server/README.md b/extensions/scarb-cairo-language-server/README.md index d19247bca..53b06187c 100644 --- a/extensions/scarb-cairo-language-server/README.md +++ b/extensions/scarb-cairo-language-server/README.md @@ -4,6 +4,6 @@ This crate bundles the `cairo-language-server` binary from [cairo](https://githu distribution. [Scarb](https://docs.swmansion.com/scarb) is a build toolchain and package manager for the [Cairo language](https://www.cairo-lang.org/). -See the [Scarb documentation](https://docs.swmansion.com/scarb/docs) for details on +See the [Scarb documentation](https://docs.swmansion.com/scarb/docs.html) for details on Scarb itself. See the [Cairo documentation](https://www.cairo-lang.org/docs) for details on Cairo. diff --git a/install.sh b/install.sh index c72aeba28..764ea76cd 100755 --- a/install.sh +++ b/install.sh @@ -30,7 +30,7 @@ Options: -h, --help Print help -v, --version Specify Scarb version to install -For more information, check out https://docs.swmansion.com/scarb/download. +For more information, check out https://docs.swmansion.com/scarb/download.html. EOF } diff --git a/scarb-metadata/README.md b/scarb-metadata/README.md index 948fb1540..d169b2b9e 100644 --- a/scarb-metadata/README.md +++ b/scarb-metadata/README.md @@ -3,7 +3,7 @@ This crate provides structured access to the output of `scarb metadata` command. [Scarb](https://docs.swmansion.com/scarb) is a build toolchain and package manager for the [Cairo language](https://www.cairo-lang.org/). -See the [Scarb documentation](https://docs.swmansion.com/scarb/docs) for details on +See the [Scarb documentation](https://docs.swmansion.com/scarb/docs.html) for details on Scarb itself. With the `command` feature (enabled by default), it also exposes an ergonomic interface to collect metadata from Scarb. diff --git a/scarb-metadata/src/lib.rs b/scarb-metadata/src/lib.rs index 73d027f95..d177bde84 100644 --- a/scarb-metadata/src/lib.rs +++ b/scarb-metadata/src/lib.rs @@ -11,7 +11,7 @@ //! //! [Scarb](https://docs.swmansion.com/scarb) is a build toolchain and package manager for //! the [Cairo language](https://www.cairo-lang.org/). -//! See the [Scarb documentation](https://docs.swmansion.com/scarb/docs) for details on +//! See the [Scarb documentation](https://docs.swmansion.com/scarb/docs.html) for details on //! Scarb itself. //! //! With the `command` feature (enabled by default), this crate also exposes an ergonomic interface diff --git a/scarb/src/core/package/name.rs b/scarb/src/core/package/name.rs index 752ed5850..6ddb2c159 100644 --- a/scarb/src/core/package/name.rs +++ b/scarb/src/core/package/name.rs @@ -18,7 +18,8 @@ use crate::core::Package; /// * [`Clone`] is `O(1)`. /// * Short names (which is common for package names) are stack-allocated. /// -/// Package naming rules are described in [Scarb docs](https://docs.swmansion.com/scarb/docs/reference/manifest#name). +/// Package naming rules are described in +/// [Scarb docs](https://docs.swmansion.com/scarb/docs/reference/manifest.html#name). #[derive(Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize)] #[serde(into = "SmolStr", try_from = "SmolStr")] pub struct PackageName(SmolStr); diff --git a/scarb/src/ops/new.rs b/scarb/src/ops/new.rs index 6232d7f61..c4c7f5176 100644 --- a/scarb/src/ops/new.rs +++ b/scarb/src/ops/new.rs @@ -119,7 +119,7 @@ fn mk( name = "{name}" version = "0.1.0" - # See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest + # See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest.html [dependencies] # foo = {{ path = "vendor/foo" }}