From 8c456666ff3194469275260db60968af797b9356 Mon Sep 17 00:00:00 2001 From: Michael Bryan Date: Wed, 14 Mar 2018 23:45:20 +0800 Subject: [PATCH] Added a stability warning to the API docs --- src/lib.rs | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 61040e6d..92fb8389 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,8 @@ //! # mdBook //! -//! **mdBook** is similar to GitBook but implemented in Rust. -//! It offers a command line interface, but can also be used as a regular crate. +//! **mdBook** is a tool for rendering a collection of markdown documents into +//! a form more suitable for end users like HTML or EPUB. It offers a command +//! line interface, but this crate can be used if more control is required. //! //! This is the API doc, the [user guide] is also available if you want //! information about the command line tool, format, structure etc. It is also @@ -15,6 +16,12 @@ //! - Accessing the public API to help create a new Renderer //! - ... //! +//! > **Note:** While we try to ensure `mdbook`'s command-line interface and +//! > behaviour are backwards compatible, the tool's internals are still +//! > evolving and being iterated on. If you wish to prevent accidental +//! > breakages it is recommended to pin any tools building on top of the +//! > `mdbook` crate to a specific release. +//! //! # Examples //! //! If creating a new book from scratch, you'll want to get a `BookBuilder` via