From 2d1c6872eaac4405bf74efa011156a5d49a0bff3 Mon Sep 17 00:00:00 2001
From: Oscar Hinton <Hinton@users.noreply.github.com>
Date: Thu, 26 Sep 2024 19:12:43 +0200
Subject: [PATCH] Add links to documentation (#1085)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## 📔 Objective

<!-- Describe what the purpose of this PR is, for example what bug
you're fixing or new feature you're adding. -->

Add links to documentation.

## ⏰ Reminders before review

- Contributor guidelines followed
- All formatters and local linters executed and passed
- Written new unit and / or integration tests where applicable
- Protected functional changes with optionality (feature flags)
- Used internationalization (i18n) for all UI strings
- CI builds passed
- Communicated to DevOps any deployment requirements
- Updated any necessary documentation (Confluence, contributing docs) or
informed the documentation
  team

## 🦮 Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire!
-->

- 👍 (`:+1:`) or similar for great changes
- 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info
- ❓ (`:question:`) for questions
- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry
that's not quite a confirmed
  issue and could potentially benefit from discussion
- 🎨 (`:art:`) for suggestions / improvements
- ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or
concerns needing attention
- 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or
indications of technical debt
- ⛏ (`:pick:`) for minor or nitpick changes
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 497af6547..14ca1f667 100644
--- a/README.md
+++ b/README.md
@@ -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/latest/bitwarden/) for the public SDK.
+- 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