src/rustdoc-json-types/README.md

   1 # Rustdoc JSON Types
   2
   3 This crate exposes the Rustdoc JSON API as a set of types with serde implementations.
   4 These types are part of the public interface of the rustdoc JSON output, and making them
   5 their own crate allows them to be versioned and distributed without having to depend on
   6 any rustc/rustdoc internals. This way, consumers can rely on this crate for both documentation
   7 of the output, and as a way to read the output easily, and its versioning is intended to
   8 follow semver guarantees about the version of the format. JSON format X will always be
   9 compatible with rustdoc-json-types version N.
  10
  11 Currently, this crate is only used by rustdoc itself. Upon the stabilization of
  12 rustdoc-json, it may be distributed separately for consumers of the API.