Skip to content

Commit

Permalink
Update links to contain .html suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
mkaput committed Aug 8, 2023
1 parent 214726f commit e9078dd
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 18 deletions.
6 changes: 3 additions & 3 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/...
```
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/cairo_run_example/Scarb.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
2 changes: 1 addition & 1 deletion examples/hello_world/Scarb.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
2 changes: 1 addition & 1 deletion examples/starknet_hello_world/Scarb.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion examples/starknet_multiple_contracts/Scarb.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion extensions/scarb-cairo-language-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down
2 changes: 1 addition & 1 deletion scarb-metadata/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion scarb-metadata/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion scarb/src/core/package/name.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion scarb/src/ops/new.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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" }}
Expand Down

0 comments on commit e9078dd

Please sign in to comment.