diff --git a/ruma-api-macros/README.md b/ruma-api-macros/README.md index 4dfdbc96..0aba52b0 100644 --- a/ruma-api-macros/README.md +++ b/ruma-api-macros/README.md @@ -1,8 +1,10 @@ # ruma-api-macros -**ruma-api-macros** provides a procedural macro for easily generating [ruma-api](https://github.com/ruma/ruma-api)-compatible API endpoints. +**ruma-api-macros** provides a procedural macro for easily generating [ruma-api]-compatible API endpoints. You define the endpoint's metadata, request fields, and response fields, and the macro generates all the necessary types and implements all the necessary traits. +[ruma-api]: https://github.com/ruma/ruma/tree/master/ruma-api + ## Usage This crate is not meant to be used directly; instead, you can use it through the re-exports in ruma-api. diff --git a/ruma-api-macros/src/lib.rs b/ruma-api-macros/src/lib.rs index 076defa9..cc324af5 100644 --- a/ruma-api-macros/src/lib.rs +++ b/ruma-api-macros/src/lib.rs @@ -1,9 +1,11 @@ //! Crate ruma-api-macros provides a procedural macro for easily generating -//! [ruma-api](https://github.com/ruma/ruma-api)-compatible endpoints. +//! [ruma-api]-compatible endpoints. //! //! This crate should never be used directly; instead, use it through the //! re-exports in ruma-api. Also note that for technical reasons, the //! `ruma_api!` macro is only documented in ruma-api, not here. +//! +//! [ruma-api]: https://github.com/ruma/ruma/tree/master/ruma-api #![allow(clippy::cognitive_complexity)] // Remove this once https://github.com/rust-lang/rust/issues/54883 becomes stable diff --git a/ruma-api/CHANGELOG.md b/ruma-api/CHANGELOG.md index 8960cd04..a4178a4d 100644 --- a/ruma-api/CHANGELOG.md +++ b/ruma-api/CHANGELOG.md @@ -181,7 +181,9 @@ Breaking changes: Breaking changes: -The crate has been redesign to focus on conversions between an endpoint's request and response types and Hyper request and response types. Implementations are expected to be generated via [ruma-api-macros](https://github.com/ruma/ruma-api-macros). +The crate has been redesign to focus on conversions between an endpoint's request and response types and Hyper request and response types. Implementations are expected to be generated via [ruma-api-macros]. + +[ruma-api-macros]: https://github.com/ruma/ruma/tree/master/ruma-api-macros # 0.3.0 diff --git a/ruma-client/Cargo.toml b/ruma-client/Cargo.toml index 50f4a50f..a5318e68 100644 --- a/ruma-client/Cargo.toml +++ b/ruma-client/Cargo.toml @@ -7,12 +7,12 @@ categories = ["api-bindings", "web-programming"] description = "A Matrix client library." documentation = "https://docs.rs/ruma-client" edition = "2018" -homepage = "https://github.com/ruma/ruma-client" +homepage = "https://www.ruma.io/" keywords = ["matrix", "chat", "messaging", "ruma"] license = "MIT" name = "ruma-client" readme = "README.md" -repository = "https://github.com/ruma/ruma-client" +repository = "https://github.com/ruma/ruma" version = "0.4.0" [dependencies] diff --git a/ruma-events-macros/README.md b/ruma-events-macros/README.md index e528bf0f..03c74532 100644 --- a/ruma-events-macros/README.md +++ b/ruma-events-macros/README.md @@ -1,6 +1,8 @@ # ruma-events-macros -**ruma-events-macros** provides a procedural macro for easily generating event types for [ruma-events](https://github.com/ruma/ruma-events). +**ruma-events-macros** provides a procedural macro for easily generating event types for [ruma-events]. + +[ruma-events]: https://github.com/ruma/ruma/tree/master/ruma-events ## Documentation diff --git a/ruma-events-macros/src/lib.rs b/ruma-events-macros/src/lib.rs index ca668511..68a09ecb 100644 --- a/ruma-events-macros/src/lib.rs +++ b/ruma-events-macros/src/lib.rs @@ -1,7 +1,9 @@ //! Crate `ruma_events_macros` provides a procedural macro for generating -//! [ruma-events](https://github.com/ruma/ruma-events) events. +//! [ruma-events] events. //! //! See the documentation for the individual macros for usage details. +//! +//! [ruma-events]: https://github.com/ruma/ruma/tree/master/ruma-events #![deny(missing_copy_implementations, missing_debug_implementations, missing_docs)] diff --git a/ruma-identifiers/CHANGELOG.md b/ruma-identifiers/CHANGELOG.md index ae04f459..28d8bf86 100644 --- a/ruma-identifiers/CHANGELOG.md +++ b/ruma-identifiers/CHANGELOG.md @@ -57,7 +57,7 @@ Breaking changes: exceeding 32 code points in length). Use the `TryFrom<&str>` or `TryFrom` implementation instead. * Remove diesel integration. If you were using it, please comment on the corresponding issue: - https://github.com/ruma/ruma-identifiers/issues/22 + [#22](https://github.com/ruma/ruma-identifiers/issues/22) * Remove `TryFrom>` implementations for identifier types * Update `parse_with_server_name`s signature (instead of `Into` it now requires `Into>` of the id type). This is technically a breaking change, but extremely unlikely