Skip to content

docs: daemon: add documentation to remaining missing parts#149

Open
artiepoole wants to merge 11 commits intomainfrom
artie/document-daemon-remaining
Open

docs: daemon: add documentation to remaining missing parts#149
artiepoole wants to merge 11 commits intomainfrom
artie/document-daemon-remaining

Conversation

@artiepoole
Copy link
Copy Markdown
Collaborator

@artiepoole artiepoole commented Jan 22, 2026

No description provided.

@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch from df20892 to fea319a Compare January 22, 2026 13:40
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch 2 times, most recently from 9787c7f to 32f6f34 Compare January 22, 2026 14:12
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch from 32f6f34 to 535387c Compare January 22, 2026 18:07
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch 2 times, most recently from 34394d2 to 8ca928f Compare February 19, 2026 15:06
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch from b9873c6 to 6b4f386 Compare March 24, 2026 09:57
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch 2 times, most recently from 66a5bd1 to e1aba62 Compare March 24, 2026 11:38
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch from e1aba62 to 992ea42 Compare March 24, 2026 16:19
@artiepoole artiepoole marked this pull request as ready for review March 24, 2026 16:22
@artiepoole artiepoole requested a review from Copilot March 24, 2026 16:22
@artiepoole artiepoole marked this pull request as draft March 24, 2026 16:22
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR primarily improves project documentation (module-level rustdocs and READMEs) across the daemon and macros crates, and also adjusts Cargo/workspace metadata to support publishing and clearer crate identity.

Changes:

  • Add/expand rustdoc module documentation and examples across daemon/src/** and fpgad_macros/src/lib.rs.
  • Introduce new READMEs / included docs (e.g., daemon/src/softeners/README.md, fpgad_macros/README.md) and a root PUBLISHING.md.
  • Centralize package metadata via [workspace.package] and rename crates/packages (daemonfpgad, clifpgad_cli).

Reviewed changes

Copilot reviewed 22 out of 23 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
fpgad_macros/src/lib.rs Adds crate/docs inclusion and rustdoc for the #[platform] proc-macro.
fpgad_macros/README.md New README describing macros crate usage.
fpgad_macros/Cargo.toml Moves metadata to workspace + adds publish-oriented metadata.
daemon/src/system_io.rs Adds module/function rustdocs and examples for filesystem helpers.
daemon/src/softeners/error.rs Adds module/enum rustdocs for softener error types.
daemon/src/softeners/README.md Large new softeners guide, included via softeners.rs.
daemon/src/softeners.rs Includes the softeners README into rustdoc output.
daemon/src/platforms/universal_components/universal_overlay_handler.rs Adds module/type/method rustdocs for overlay handling.
daemon/src/platforms/universal_components/universal_fpga.rs Adds module/type/method rustdocs for FPGA sysfs handling.
daemon/src/platforms/universal_components.rs Removes README include (module now just exports submodules).
daemon/src/platforms/universal.rs Adds module/type/method rustdocs for universal platform.
daemon/src/platforms/platform.rs Adds module/trait/function rustdocs for platform registry/traits.
daemon/src/platforms/README.md Updates platforms documentation text and references.
daemon/src/platforms.rs Includes platforms README into rustdoc output.
daemon/src/main.rs Adds crate-level rustdocs for daemon entrypoint and registration.
daemon/src/error.rs Adds rustdocs describing FpgadError and DBus mapping.
daemon/src/config.rs Adds module rustdocs for configuration constants.
daemon/src/comm.rs Adds module rustdocs for comms/DBus structure.
daemon/Cargo.toml Renames package to fpgad, moves metadata to workspace, updates dependency spec.
cli/Cargo.toml Renames package/bin to fpgad_cli, moves metadata to workspace.
PUBLISHING.md New publishing guide and process notes.
Cargo.toml Adds [workspace.package] shared metadata.
Cargo.lock Updates lockfile for crate/package renames.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Base automatically changed from artie/document_cli to main March 26, 2026 09:52
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
…ftener

Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
a todo:
- add an example of fetching the correct platform object

Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 22 out of 23 changed files in this pull request and generated 10 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch 2 times, most recently from 427db72 to 8b60723 Compare March 26, 2026 14:40
@artiepoole artiepoole marked this pull request as ready for review March 26, 2026 15:16
@artiepoole artiepoole marked this pull request as draft March 26, 2026 15:17
includes
- adding new softener error to enum
- adding custom fpga and custom overlayhandler files

Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
@artiepoole artiepoole force-pushed the artie/document-daemon-remaining branch from 757e673 to 25e8196 Compare March 26, 2026 15:21
@artiepoole
Copy link
Copy Markdown
Collaborator Author

artiepoole commented Mar 26, 2026

I previously accidentally added some cargo.toml and project name changes into this PR, these have been pushed to #158 which prepares for publishing - the final PR in this chain before dfx-mgr changes.

This was previously causing snap builds to fail with "bin/daemon doesn't exist". Should be fixed 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants