Skip to content

Commit aba2aea

Browse files
authored
fix: describe documentation and add links in api reference (#79)
All documentation should be discoverable from other documentation. Now the book links to the api reference, and the api reference should link to the book. This change adds those links, and also generally describes the purpose of the book vs the api reference.
1 parent 043ddcd commit aba2aea

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

release-please-config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"extra-files": [
1111
"README.md",
1212
"book/src/README.md",
13-
"book/src/api-reference.md"
13+
"book/src/api-reference.md",
14+
"src/lib.rs"
1415
],
1516
"changelog-sections": [
1617
{"type": "feat", "section": "Features"},

src/lib.rs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
#![doc = include_str!("../book/src/blurb.md")]
2+
//!
3+
//! ## This API Reference
4+
//! The purpose of this API reference is to describe the API provided by this library.
5+
//! More explanation-oriented documentation, tutorials, and guides are available in the
6+
//! [`bevy_pipe_affect` book](https://trouv.github.io/bevy_pipe_affect/v0.1.0). <!-- x-release-please-version -->
7+
//!
8+
//! The following are good jumping-off points for beginners:
9+
//! - [*Motivations* explanation](https://trouv.github.io/bevy_pipe_affect/v0.1.0/explanation/motivations.html) <!-- x-release-please-version -->
10+
//! - [*effects* module api reference](effects) (a list of effects and constructors provided by the library)
11+
//!
12+
//! Cargo examples are also available in this library's
13+
//! [github repository](https://github.com/Trouv/bevy_pipe_affect/tree/v0.1.0/examples). <!-- x-release-please-version -->
214
#![warn(missing_docs)]
315
#![deny(rustdoc::all)]
416

0 commit comments

Comments
 (0)