diff --git a/CHANGELOG.md b/CHANGELOG.md index 644a30a..9784245 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -527,7 +527,7 @@ Thanks! - First crates.io release -[user documentation]: https://tealdeer-rs.github.io/tealdeer/ +[user documentation]: https://docs.tealdeer.org [@0ndorio]: https://github.com/0ndorio [@adamazing]: https://github.com/adamazing diff --git a/Cargo.toml b/Cargo.toml index 5849184..57a560e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ license = "MIT OR Apache-2.0" name = "tealdeer" readme = "README.md" repository = "https://github.com/tealdeer-rs/tealdeer/" -documentation = "https://tealdeer-rs.github.io/tealdeer/" +documentation = "https://docs.tealdeer.org" version = "1.8.1" include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png", "completion/*"] rust-version = "1.87" # MSRV diff --git a/README.md b/README.md index 859d06f..14da2f3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ binaries on the [GitHub releases page](https://github.com/tealdeer-rs/tealdeer/r ## Docs (Installing, Usage, Configuration) -User documentation is available at ! +User documentation is available at ! The docs are generated using [mdbook](https://rust-lang.github.io/mdBook/index.html). They can be edited through the markdown files in the `docs/src/` directory. @@ -94,7 +94,7 @@ Using AI is generally discouraged. However, if it is used as part of a contribut 2. Check all output of AI tools before sharing it with others in the tealdeer project. 3. Not post slop, spam, or low quality contributions. This includes pull request descriptions and comments with excessive text and markdown flair. 4. Leave small or easy tasks to new contributors who want to learn without the use of AI. This is to maintain the presence of the `good-first-issue` tag. -5. Be respectful of everyone's time: *maintainers and other contributors will be reviewing your PRs.* +5. Be respectful of everyone's time: *maintainers and other contributors will be reviewing your PRs.* ## MSRV (Minimally Supported Rust Version) diff --git a/docs/src/usage.txt b/docs/src/usage.txt index 0db9cc9..ad7b845 100644 --- a/docs/src/usage.txt +++ b/docs/src/usage.txt @@ -31,6 +31,6 @@ Options: -v, --version Print the version -h, --help Print help -To view the user documentation, please visit https://tealdeer-rs.github.io/tealdeer/. +To view the user documentation, please visit https://docs.tealdeer.org. To view usage examples, run tldr tldr or tldr tealdeer. diff --git a/pages/tealdeer.md b/pages/tealdeer.md index 948b278..d08a351 100644 --- a/pages/tealdeer.md +++ b/pages/tealdeer.md @@ -1,7 +1,7 @@ # tldr > This is a builtin page that shows information for your installed tealdeer version. -> More information: . +> More information: . > This page shows tealdeer specific functionality. See tldr tldr for more examples. diff --git a/src/cli.rs b/src/cli.rs index 81d789f..5dc58f5 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -18,7 +18,7 @@ use crate::types::{ColorOptions, PlatformType}; {usage-heading} {usage} {all-args}{after-help}", - after_help = "To view the user documentation, please visit https://tealdeer-rs.github.io/tealdeer/. + after_help = "To view the user documentation, please visit https://docs.tealdeer.org. To view usage examples, run tldr tldr or tldr tealdeer.", arg_required_else_help = true, diff --git a/src/main.rs b/src/main.rs index 1480814..52515b5 100644 --- a/src/main.rs +++ b/src/main.rs @@ -363,7 +363,7 @@ fn try_main(args: Cli, enable_styles: bool) -> Result { println!("The path to your config file can be looked up with `tldr --show-paths`."); println!("To create an initial config file, use `tldr --seed-config`.\n"); println!("You can find more tips and tricks in our docs:\n"); - println!(" https://tealdeer-rs.github.io/tealdeer/config_updates.html"); + println!(" https://docs.tealdeer.org"); } return Ok(ExitCode::FAILURE);