Conversation
Deploying contributing-docs with
|
| Latest commit: |
c369611
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5e4afa91.contributing-docs.pages.dev |
| Branch Preview URL: | https://sdk-docs.contributing-docs.pages.dev |
|
Great job! No new security vulnerabilities introduced in this pull request |
There was a problem hiding this comment.
I wonder if we could make a template using https://crates.io/crates/cargo-generate to streamline this process. Have two templates, one for feature crates and another for util crates.
There was a problem hiding this comment.
I've had good luck letting claude do it in the past, but I agree a utility that would create the crate structure, manifest and properly configured client would be nice
There was a problem hiding this comment.
A new Claude skill to add to the ai-plugins marketplace perhaps 🤔
Hinton
changed the title
There was a problem hiding this comment.
I've had good luck letting claude do it in the past, but I agree a utility that would create the crate structure, manifest and properly configured client would be nice
|
|
||
| ## 2. Create the crate | ||
|
|
||
| When the functionality warrants its own crate — typically when it represents a distinct domain — add |
There was a problem hiding this comment.
Should we add more guidance on whether to create a crate vs reuse an existing one, or how big the scope of a crate should be? represents a distinct domain is pretty ambiguous
There was a problem hiding this comment.
It is, but I feel it's partially up to the teams to identify that.
| ``` | ||
|
|
||
| If the client will be exposed over WASM, annotate it with | ||
| `#[cfg_attr(feature = "wasm", wasm_bindgen)]`. |
There was a problem hiding this comment.
We don't mention when creating the crate above that the feature needs to exist. Maybe we just always instruct to add a uniffi/wasm feature to all feature crates?
There was a problem hiding this comment.
This ties into my thought for having a template.
withinfocus
changed the title
theMickster
left a comment
theMickster
left a comment
There was a problem hiding this comment.
The PR is well-written and does a great job to tidy up a number of heading case issues that resided from prior work. A couple minor adjustments to new headers and I think we are in great shape. Thanks for the great work here, @Hinton!
There was a problem hiding this comment.
A new Claude skill to add to the ai-plugins marketplace perhaps 🤔
| <Bitwarden>We have compiled a list of resources for learning Rust in a | ||
| [Confluence page](https://bitwarden.atlassian.net/wiki/spaces/DEV/pages/517898288/Rust+Learning+Resources).</Bitwarden> | ||
| For API documentation view the latest | ||
| [API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) that also includes |
There was a problem hiding this comment.
This link is broken
| [API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) that also includes | |
| [API documentation](https://sdk-api-docs.bitwarden.com/index.html) that also includes |
4 participants
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-33733
📔 Objective
Refresh of the SDK architecture documentation. Reorganizing it into new sections and expands identified gaps.
📸 Screenshots