From dc59653a0d1c9252a235d7743e4f31287a7a2661 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Tue, 6 Dec 2022 18:04:39 +0100 Subject: [PATCH 1/4] Add master docs note --- README.md | 1 + src/lib.rs | 3 +++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index f5813a56679..47a1d874b63 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![dependency status](https://deps.rs/repo/github/libp2p/rust-libp2p/status.svg?style=flat-square)](https://deps.rs/repo/github/libp2p/rust-libp2p) [![Crates.io](https://img.shields.io/crates/v/libp2p.svg)](https://crates.io/crates/libp2p) [![docs.rs](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/libp2p) +[![docs.rs master](https://img.shields.io/badge/docs-master-blueviolet)](https://libp2p.github.io/rust-libp2p/libp2p/) This repository is the central place for Rust development of the [libp2p](https://libp2p.io) spec. diff --git a/src/lib.rs b/src/lib.rs index 1d80de1bd89..1cd01b262df 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,6 +18,9 @@ // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. +// Remove this note before publishing +//! # ⚠️ WARNING You are viewing the master docs +//! //! libp2p is a modular peer-to-peer networking framework. //! //! To learn more about the general libp2p multi-language framework visit From 42532e88cf434d097eca35682636d9ac57dde278 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Thu, 8 Dec 2022 15:44:56 +0100 Subject: [PATCH 2/4] Remove unnecessary notice --- src/lib.rs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 1cd01b262df..2b9eae1daf2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,11 +18,6 @@ // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. -// Remove this note before publishing -//! # ⚠️ WARNING You are viewing the master docs -//! -//! libp2p is a modular peer-to-peer networking framework. -//! //! To learn more about the general libp2p multi-language framework visit //! [libp2p.io](https://libp2p.io/). //! From a2cc5418755b76bdc49338ae0fde01b11bea2f65 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Fri, 9 Dec 2022 00:08:41 +0100 Subject: [PATCH 3/4] Remove unnecessary change --- src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/lib.rs b/src/lib.rs index 2b9eae1daf2..e1a205a9f9e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -18,6 +18,7 @@ // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. +//! libp2p is a modular peer-to-peer networking framework. //! To learn more about the general libp2p multi-language framework visit //! [libp2p.io](https://libp2p.io/). //! From eeb73f808ea3887d292b96ec6e19aba0df3c9cc4 Mon Sep 17 00:00:00 2001 From: umgefahren <55623006+umgefahren@users.noreply.github.com> Date: Fri, 9 Dec 2022 00:09:32 +0100 Subject: [PATCH 4/4] Restore new line --- src/lib.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/lib.rs b/src/lib.rs index e1a205a9f9e..1d80de1bd89 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,6 +19,7 @@ // DEALINGS IN THE SOFTWARE. //! libp2p is a modular peer-to-peer networking framework. +//! //! To learn more about the general libp2p multi-language framework visit //! [libp2p.io](https://libp2p.io/). //!