From f6127bcb36b46e61f02e7d49ef77a7dca9c371e9 Mon Sep 17 00:00:00 2001 From: Zeeshan Ali Khan Date: Thu, 26 Mar 2026 22:52:08 +0100 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=9A=91=EF=B8=8F=20Fix=20doc=20build?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- firmware-controller/Cargo.toml | 2 +- firmware-controller/README.md | 1 + firmware-controller/src/lib.rs | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) create mode 120000 firmware-controller/README.md diff --git a/firmware-controller/Cargo.toml b/firmware-controller/Cargo.toml index 6cc8768..844e566 100644 --- a/firmware-controller/Cargo.toml +++ b/firmware-controller/Cargo.toml @@ -9,7 +9,7 @@ authors = [ ] license = "MIT" repository = "https://github.com/layerx-world/firmware-controller/" -readme = "../README.md" +readme = "README.md" [features] default = ["embassy"] diff --git a/firmware-controller/README.md b/firmware-controller/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/firmware-controller/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/firmware-controller/src/lib.rs b/firmware-controller/src/lib.rs index 0ba767f..31b3af3 100644 --- a/firmware-controller/src/lib.rs +++ b/firmware-controller/src/lib.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #[cfg(not(any(feature = "embassy", feature = "tokio")))] compile_error!("Either the `embassy` or `tokio` feature must be enabled"); From d9f4f15787cfc20c218e6c018221c5c86ba62fe9 Mon Sep 17 00:00:00 2001 From: Zeeshan Ali Khan Date: Thu, 26 Mar 2026 22:52:25 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=91=B7=20Check=20docs=20build=20in=20?= =?UTF-8?q?the=20CI?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/rust.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/rust.yaml b/.github/workflows/rust.yaml index 9c66bd3..a80c8cc 100644 --- a/.github/workflows/rust.yaml +++ b/.github/workflows/rust.yaml @@ -51,3 +51,15 @@ jobs: run: >- cargo --locked clippy --workspace --no-default-features --features "${{ matrix.backend }}" -- -D warnings + + doc_build: + runs-on: ubuntu-latest + env: + RUSTDOCFLAGS: -D warnings + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@master + with: + toolchain: stable + - name: Check documentation build + run: cargo --locked doc --workspace