Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Matt Bishop <[email protected]>
  • Loading branch information
Hinton and withinfocus authored Sep 27, 2024
1 parent ff63e6b commit d254815
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/architecture/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ SDK for the Bitwarden [Password Manager][pm]. The SDK is written in Rust and pro
multiple languages. The general end goal of the SDK is to own everything up to the presentational
layers. This includes but is not limited to: API calls, data models, encryption, and business logic.

<Bitwarden>We have compiled a list of resources for learning rust in a
<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) which also includes
[API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) that also includes
internal private items.

## Architecture

The Bitwarden SDK is structured as a single [Git repository](https://github.com/bitwarden/sdk) with
multiple internal crates. Please review the README in the repository for up to date information
multiple internal crates. Please review the `README` in the repository for up to date information
about the different crates.

We generally strive towards extracting features into separate crates to keep the `bitwarden-core`
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/sdk/server-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ let response: SyncResponseModel =
bitwarden_api_api::apis::sync_api::sync_get(&config.api, exclude_subdomains).await?;
```

You SHOULD not expose the request and response models of the auto generated bindings and SHOULD
You *should not* expose the request and response models of the auto generated bindings and *should*
instead define and use your own models. This ensures the server request / response models are
decoupled from the SDK models, which allows for easier changes in the future without breaking
backwards compatibility.
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SDK for the Bitwarden [Password Manager][pm]. The SDK is written in Rust and pro
multiple languages.

For more in-depth documentation please review the [SDK Architecture](../../architecture/sdk) page
and the project's [README](https://github.com/bitwarden/sdk).
and the project's [`README`](https://github.com/bitwarden/sdk).

## Requirements

Expand Down Expand Up @@ -42,7 +42,7 @@ To build the SDK, run the following command:
cargo build
```

## Linking SDK to clients
## Linking the SDK to clients

After modifying the SDK, it can be beneficial to test the changes in the client applications. To do
so you will need to update the SDK reference in the client applications.
Expand Down

0 comments on commit d254815

Please sign in to comment.