diff --git a/.crate-docs.md b/.crate-docs.md index 10fec4d..9310783 100644 --- a/.crate-docs.md +++ b/.crate-docs.md @@ -1,6 +1,7 @@ ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) -[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)](https://khonsu.dev/cushy/main/docs/cushy/) +[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://cushy.rs/main/docs/cushy/) +[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-main-informational)][guide] Cushy is an experimental Graphical User Interface (GUI) crate for the Rust programming language. It features a reactive data model and aims to enable @@ -46,9 +47,12 @@ fn main() -> cushy::Result { } ``` -A great way to learn more about Cushy is to explore the [examples -directory][examples]. Nearly every feature in Cushy was initially tested by -creating an example. +Here are some ways to learn more about Cushy: + +- Explore the [examples directory][examples]. Nearly every feature in Cushy was +initially tested by creating an example. +- Browse the [user's guide][guide]. +- Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status @@ -76,6 +80,9 @@ Cushy. [arboard]: https://github.com/1Password/arboard [ecton]: https://github.com/khonsulabs/ecton [issues]: https://github.com/khonsulabs/cushy/issues +[guide]: https://cushy.rs/main/guide/ +[discussions]: https://github.com/khonsulabs/cushy/discussions +[discord]: https://discord.khonsulabs.com/ ## Open-source Licenses diff --git a/.rustme/config.ron b/.rustme/config.ron index 805e1fb..b3c013b 100644 --- a/.rustme/config.ron +++ b/.rustme/config.ron @@ -37,16 +37,16 @@ Configuration( release: "v0.2.0", ), "docs": ( - default: "https://khonsu.dev/cushy/main/docs/cushy/", + default: "https://cushy.rs/main/docs/cushy/", release: "https://docs.rs/cushy", ), "widget": ( - default: "https://khonsu.dev/cushy/main/docs/cushy/widget/trait.Widget.html", + default: "https://cushy.rs/main/docs/cushy/widget/trait.Widget.html", release: "https://docs.rs/cushy/*/cushy/widget/trait.Widget.html", for_docs: "crate::widget::Widget", ), "widgets": ( - default: "https://khonsu.dev/cushy/main/docs/cushy/widgets/index.html", + default: "https://cushy.rs/main/docs/cushy/widgets/index.html", release: "https://docs.rs/cushy/*/cushy/widgets/index.html", for_docs: "mod@crate::widgets", ), diff --git a/.rustme/docs.md b/.rustme/docs.md index 89a8d70..b8fb05b 100644 --- a/.rustme/docs.md +++ b/.rustme/docs.md @@ -1,6 +1,7 @@ ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) -[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)]($docs$) +[![Documentation for `$ref-name$`](https://img.shields.io/badge/docs-$ref-name$-informational)]($docs$) +[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-$ref-name$-informational)][guide] Cushy is an experimental Graphical User Interface (GUI) crate for the Rust programming language. It features a reactive data model and aims to enable @@ -33,9 +34,12 @@ increments its own label: $../examples/basic-button.rs:readme$ ``` -A great way to learn more about Cushy is to explore the [examples -directory][examples]. Nearly every feature in Cushy was initially tested by -creating an example. +Here are some ways to learn more about Cushy: + +- Explore the [examples directory][examples]. Nearly every feature in Cushy was +initially tested by creating an example. +- Browse the [user's guide][guide]. +- Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status @@ -63,3 +67,6 @@ Cushy. [arboard]: https://github.com/1Password/arboard [ecton]: https://github.com/khonsulabs/ecton [issues]: https://github.com/khonsulabs/cushy/issues +[guide]: https://cushy.rs/$ref-name$/guide/ +[discussions]: https://github.com/khonsulabs/cushy/discussions +[discord]: https://discord.khonsulabs.com/ diff --git a/README.md b/README.md index 86d288e..e30ca24 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ ![Cushy is considered alpha and unsupported](https://img.shields.io/badge/status-alpha-orange) [![crate version](https://img.shields.io/crates/v/cushy.svg)](https://crates.io/crates/cushy) -[![Documentation for `main` branch](https://img.shields.io/badge/docs-main-informational)](https://khonsu.dev/cushy/main/docs/cushy/) +[![Documentation for `main`](https://img.shields.io/badge/docs-main-informational)](https://cushy.rs/main/docs/cushy/) +[![Cushy User's Guide](https://img.shields.io/badge/user%27s%20guide-main-informational)][guide] Cushy is an experimental Graphical User Interface (GUI) crate for the Rust programming language. It features a reactive data model and aims to enable @@ -48,9 +49,12 @@ fn main() -> cushy::Result { } ``` -A great way to learn more about Cushy is to explore the [examples -directory][examples]. Nearly every feature in Cushy was initially tested by -creating an example. +Here are some ways to learn more about Cushy: + +- Explore the [examples directory][examples]. Nearly every feature in Cushy was +initially tested by creating an example. +- Browse the [user's guide][guide]. +- Ask questions [in Discussions][discussions] or [on Discord][discord]. ## Project Status @@ -65,8 +69,8 @@ and problem it aims to solve. Doing so will help prevent friction in merging pull requests, as it ensures changes fit the vision the maintainers have for Cushy. -[widget]: https://khonsu.dev/cushy/main/docs/cushy/widget/trait.Widget.html -[widgets]: https://khonsu.dev/cushy/main/docs/cushy/widgets/index.html +[widget]: https://cushy.rs/main/docs/cushy/widget/trait.Widget.html +[widgets]: https://cushy.rs/main/docs/cushy/widgets/index.html [button-example]: https://github.com/khonsulabs/cushy/tree/main/examples/basic-button.rs [examples]: https://github.com/khonsulabs/cushy/tree/main/examples/ [kludgine]: https://github.com/khonsulabs/kludgine @@ -78,6 +82,9 @@ Cushy. [arboard]: https://github.com/1Password/arboard [ecton]: https://github.com/khonsulabs/ecton [issues]: https://github.com/khonsulabs/cushy/issues +[guide]: https://cushy.rs/main/guide/ +[discussions]: https://github.com/khonsulabs/cushy/discussions +[discord]: https://discord.khonsulabs.com/ ## Open-source Licenses