Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add links to documentation #1085

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Add links to documentation #1085

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3116ca7
Add links to documentation
Hinton Sep 26, 2024
9151413
tweak
Hinton Sep 26, 2024
84b1022
Update readme
Hinton Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,19 @@ To build, you will need the following in your PATH:
- We recommend installing this via the
[Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)

## Documentation

Please refer to our [Contributing Docs](https://contributing.bitwarden.com/) for
[getting started](https://contributing.bitwarden.com/getting-started/sdk/) instructions and
[architectural documentation](https://contributing.bitwarden.com/architecture/sdk/).

You can also browse the latest published documentation:

- [docs.rs](https://docs.rs/bitwarden/0.5.0/bitwarden/) for the public SDK.
Copy link
Member

Choose a reason for hiding this comment

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

We should probably point to https://docs.rs/bitwarden/latest/bitwarden/ or https://docs.rs/bitwarden/, otherwise the link will be outdated once the next release comes out

- Or for developers of the SDK, view the internal
[API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) which includes
private items.

## Crates

The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates
Expand Down
Loading