From 03902d66064c849c3b7766397a91a3a872f13bbc Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Sun, 14 Dec 2025 15:34:19 -0500 Subject: [PATCH 1/3] Add READMEs and job to sync them. --- .github/workflows/sync-code-readmes.yml | 160 ++++++++++++++++++++++++ docs/documentation/code-readmes.md | 156 +++++++++++++++++++++++ docusaurus.config.js | 6 + sidebars.js | 1 + 4 files changed, 323 insertions(+) create mode 100644 .github/workflows/sync-code-readmes.yml create mode 100644 docs/documentation/code-readmes.md diff --git a/.github/workflows/sync-code-readmes.yml b/.github/workflows/sync-code-readmes.yml new file mode 100644 index 000000000..c820dbc47 --- /dev/null +++ b/.github/workflows/sync-code-readmes.yml @@ -0,0 +1,160 @@ +name: Sync Code README Table of Contents + +on: + # Run when manually triggered + workflow_dispatch: + # Run on a schedule (weekly on Sunday at midnight UTC) + schedule: + - cron: "0 0 * * 0" + +permissions: + contents: write + pull-requests: write + +jobs: + sync-code-readmes: + name: Sync README ToC from Bitwarden repos + runs-on: ubuntu-24.04 + + steps: + - name: Check out contributing-docs repo + uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + with: + fetch-depth: 1 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Check out repositories to document + run: | + # Array of repositories to check out + # Format: "org/repo|local-directory" + repos=( + "bitwarden/clients|clients-repo" + "bitwarden/server|server-repo" + "bitwarden/sdk-internal|sdk-internal-repo" + ) + + for repo_info in "${repos[@]}"; do + IFS='|' read -r repo_name local_dir <<< "$repo_info" + echo "Checking out $repo_name to $local_dir..." + git clone --depth 1 "https://github.com/${repo_name}.git" "$local_dir" + done + + - name: Find and process README files + run: | + # Define repositories to process + # Format: "repo_name|directory|display_name|github_org" + declare -a repos=( + "clients|clients-repo|Clients Repository|bitwarden/clients" + "server|server-repo|Server Repository|bitwarden/server" + "sdk-internal|sdk-internal-repo|SDK Internal Repository|bitwarden/sdk-internal" + ) + + # Update the existing TOC file + toc_file="docs/documentation/code-readmes.md" + + # Clear existing content but keep frontmatter + cat > "$toc_file" << 'EOF' + --- + sidebar_position: 1 + --- + + # Code Documentation + + This page provides an organized table of contents for all `README` files in the Bitwarden repositories. + + EOF + + # Process each repository + for repo_info in "${repos[@]}"; do + IFS='|' read -r repo_name repo_dir display_name github_path <<< "$repo_info" + + echo "## $display_name" >> "$toc_file" + echo "" >> "$toc_file" + echo "`README` files from [$github_path](https://github.com/$github_path)." >> "$toc_file" + echo "" >> "$toc_file" + + cd "$repo_dir" + + # Create temp file to collect all entries + temp_file=$(mktemp) + + find . -type f -iname "README*.md" -not -path "*/node_modules/*" | grep -v "^./README.md$" | while read -r readme_file; do + readme_path="${readme_file#./}" + base_folder=$(echo "$readme_path" | cut -d'/' -f1) + + # Extract title from README + title=$(grep -m 1 "^# " "$readme_file" | sed 's/^# //' || basename "$readme_path") + if [ -z "$title" ]; then + title=$(basename "$readme_path") + fi + + github_url="https://github.com/$github_path/blob/main/${readme_path}" + + # Build the display path (directory path with / separators) + # Remove the base folder from the path since it's shown in the section header + dir_path=$(dirname "$readme_path") + # If dir_path equals base_folder, the README is at the root of the section + if [ "$dir_path" = "$base_folder" ]; then + display_path="" + else + display_path=$(echo "$dir_path" | sed "s|^${base_folder}/||" | sed 's|/| / |g') + fi + + echo "${base_folder}|${readme_path}|${display_path}|${title}|${github_url}" + done > "$temp_file" + + # Sort by path to ensure alphabetical order + sort -t'|' -k2,2 "$temp_file" > "${temp_file}.sorted" + + # Generate output + current_base="" + + while IFS='|' read -r base_folder readme_path display_path title url; do + # Check if we need a new base section + if [ "$base_folder" != "$current_base" ]; then + if [ -n "$current_base" ]; then + echo "" >> "../$toc_file" + fi + echo "### $base_folder" >> "../$toc_file" + echo "" >> "../$toc_file" + current_base="$base_folder" + fi + + # Format the link text based on whether display_path is empty + if [ -z "$display_path" ]; then + echo "- [$title]($url)" >> "../$toc_file" + else + echo "- [$display_path / $title]($url)" >> "../$toc_file" + fi + done < "${temp_file}.sorted" + + echo "" >> "../$toc_file" + + cd .. + done + + # Add footer + cat >> "$toc_file" << EOF + + --- + + *This page is automatically updated by the [Sync Code READMEs workflow](https://github.com/bitwarden/contributing-docs/actions/workflows/sync-code-readmes.yml).* + + *Last updated: $(date -u +"%Y-%m-%d %H:%M:%S UTC")* + EOF + + - name: Create Pull Request + uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: "docs: Update README table of contents" + title: "docs: Update README table of contents" + body: | + This PR updates the README table of contents with all `README` files from the configured repositories. + + This is an automated PR created by the [Sync README TOC workflow](https://github.com/bitwarden/contributing-docs/actions/workflows/sync-code-readmes.yml). + branch: automated/code-readmes-update + delete-branch: true + labels: | + documentation + automated diff --git a/docs/documentation/code-readmes.md b/docs/documentation/code-readmes.md new file mode 100644 index 000000000..48f677f4c --- /dev/null +++ b/docs/documentation/code-readmes.md @@ -0,0 +1,156 @@ +--- +sidebar_position: 1 +--- + +# Code Documentation + +This page provides an organized table of contents for all `README` files in the Bitwarden +repositories. + +## Clients Repository + +README files from [bitwarden/clients](https://github.com/bitwarden/clients). + +### apps + +- [browser / Bitwarden Browser Extension](https://github.com/bitwarden/clients/blob/main/apps/browser/README.md) +- [cli / Bitwarden Command-line Interface](https://github.com/bitwarden/clients/blob/main/apps/cli/README.md) +- [desktop / Bitwarden Desktop Application](https://github.com/bitwarden/clients/blob/main/apps/desktop/README.md) +- [desktop / desktop_native / chromium_importer / Chromium Direct Importer](https://github.com/bitwarden/clients/blob/main/apps/desktop/desktop_native/chromium_importer/README.md) +- [desktop / desktop_native / macos_provider / Explainer: Mac OS Native Passkey Provider](https://github.com/bitwarden/clients/blob/main/apps/desktop/desktop_native/macos_provider/README.md) +- [desktop / desktop_native / windows_plugin_authenticator / windows-plugin-authenticator](https://github.com/bitwarden/clients/blob/main/apps/desktop/desktop_native/windows_plugin_authenticator/README.md) +- [desktop / macos / MacOS Extensions for Desktop Apps](https://github.com/bitwarden/clients/blob/main/apps/desktop/macos/README.md) +- [web / README.md](https://github.com/bitwarden/clients/blob/main/apps/web/README.md) +- [web / src / app / admin-console / organizations / policies / Adding a New Policy in Admin Console](https://github.com/bitwarden/clients/blob/main/apps/web/src/app/admin-console/organizations/policies/README.md) +- [web / src / app / auth / guards / deep-link / Deep-link Guard](https://github.com/bitwarden/clients/blob/main/apps/web/src/app/auth/guards/deep-link/readme.md) + +### bitwarden_license + +- [Bitwarden Licensed Code](https://github.com/bitwarden/clients/blob/main/bitwarden_license/README.md) + +### libs + +- [admin-console / Admin Console](https://github.com/bitwarden/clients/blob/main/libs/admin-console/README.md) +- [angular / src / auth / guards / redirect-to-vault-if-unlocked / RedirectToVaultIfUnlocked Guard](https://github.com/bitwarden/clients/blob/main/libs/angular/src/auth/guards/redirect-to-vault-if-unlocked/README.md) +- [angular / src / auth / guards / redirect / Redirect Guard](https://github.com/bitwarden/clients/blob/main/libs/angular/src/auth/guards/redirect/README.md) +- [angular / src / auth / password-management / Master Password Management Flows](https://github.com/bitwarden/clients/blob/main/libs/angular/src/auth/password-management/README.md) +- [angular / src / platform / view-cache / Extension Persistence](https://github.com/bitwarden/clients/blob/main/libs/angular/src/platform/view-cache/README.md) +- [assets / Assets](https://github.com/bitwarden/clients/blob/main/libs/assets/README.md) +- [auth / Auth](https://github.com/bitwarden/clients/blob/main/libs/auth/README.md) +- [auth / src / angular / login-via-auth-request / Login via Auth Request Documentation](https://github.com/bitwarden/clients/blob/main/libs/auth/src/angular/login-via-auth-request/README.md) +- [auth / src / common / login-strategies / Overview of Authentication at Bitwarden](https://github.com/bitwarden/clients/blob/main/libs/auth/src/common/login-strategies/README.md) +- [billing / Billing](https://github.com/bitwarden/clients/blob/main/libs/billing/README.md) +- [client-type / client-type](https://github.com/bitwarden/clients/blob/main/libs/client-type/README.md) +- [common / src / auth / abstractions / auth-request-answering / Auth Request Answering Service](https://github.com/bitwarden/clients/blob/main/libs/common/src/auth/abstractions/auth-request-answering/README.md) +- [common / src / platform / actions / Platform Actions API](https://github.com/bitwarden/clients/blob/main/libs/common/src/platform/actions/README.md) +- [common / src / tools / extension / vendor / Vendors](https://github.com/bitwarden/clients/blob/main/libs/common/src/tools/extension/vendor/readme.md) +- [common / src / tools / integration / README.md](https://github.com/bitwarden/clients/blob/main/libs/common/src/tools/integration/README.md) +- [core-test-utils / core-test-utils](https://github.com/bitwarden/clients/blob/main/libs/core-test-utils/README.md) +- [dirt / card / README.md](https://github.com/bitwarden/clients/blob/main/libs/dirt/card/README.md) +- [guid / guid](https://github.com/bitwarden/clients/blob/main/libs/guid/README.md) +- [key-management-ui / Key management UI](https://github.com/bitwarden/clients/blob/main/libs/key-management-ui/README.md) +- [key-management / Key management](https://github.com/bitwarden/clients/blob/main/libs/key-management/README.md) +- [logging / logging](https://github.com/bitwarden/clients/blob/main/libs/logging/README.md) +- [messaging / messaging](https://github.com/bitwarden/clients/blob/main/libs/messaging/README.md) +- [nx-plugin / @bitwarden/nx-plugin](https://github.com/bitwarden/clients/blob/main/libs/nx-plugin/README.md) +- [platform / Platform](https://github.com/bitwarden/clients/blob/main/libs/platform/README.md) +- [pricing / pricing](https://github.com/bitwarden/clients/blob/main/libs/pricing/README.md) +- [serialization / serialization](https://github.com/bitwarden/clients/blob/main/libs/serialization/README.md) +- [state-internal / state-internal](https://github.com/bitwarden/clients/blob/main/libs/state-internal/README.md) +- [state-test-utils / state-test-utils](https://github.com/bitwarden/clients/blob/main/libs/state-test-utils/README.md) +- [state / `@bitwarden/state`](https://github.com/bitwarden/clients/blob/main/libs/state/README.md) +- [storage-core / storage-core](https://github.com/bitwarden/clients/blob/main/libs/storage-core/README.md) +- [storage-test-utils / storage-test-utils](https://github.com/bitwarden/clients/blob/main/libs/storage-test-utils/README.md) +- [tools / Tools](https://github.com/bitwarden/clients/blob/main/libs/tools/README.md) +- [tools / export / vault-export / Vault Export](https://github.com/bitwarden/clients/blob/main/libs/tools/export/vault-export/README.md) +- [tools / generator / components / readme.md](https://github.com/bitwarden/clients/blob/main/libs/tools/generator/components/readme.md) +- [tools / send / Bitwarden Send](https://github.com/bitwarden/clients/blob/main/libs/tools/send/README.md) +- [ui / UI Foundation](https://github.com/bitwarden/clients/blob/main/libs/ui/README.md) +- [user-core / user-core](https://github.com/bitwarden/clients/blob/main/libs/user-core/README.md) +- [vault / Vault](https://github.com/bitwarden/clients/blob/main/libs/vault/README.md) + +## Server Repository + +README files from [bitwarden/server](https://github.com/bitwarden/server). + +### bitwarden_license + +- [Bitwarden Licensed Code](https://github.com/bitwarden/server/blob/main/bitwarden_license/README.md) + +### src + +- [Core / AdminConsole / OrganizationFeatures / OrganizationUsers / AutoConfirmUser / Automatic User Confirmation](https://github.com/bitwarden/server/blob/main/src/Core/AdminConsole/OrganizationFeatures/OrganizationUsers/AutoConfirmUser/README.md) +- [Core / AdminConsole / Services / Implementations / EventIntegrations / Design goals](https://github.com/bitwarden/server/blob/main/src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md) +- [Core / Auth / Identity / TokenProviders / OtpTokenProvider / OtpTokenProvider](https://github.com/bitwarden/server/blob/main/src/Core/Auth/Identity/TokenProviders/OtpTokenProvider/readme.md) +- [Core / Auth / Services / EmergencyAccess / Emergency Access System](https://github.com/bitwarden/server/blob/main/src/Core/Auth/Services/EmergencyAccess/readme.md) +- [Core / MailTemplates / Mjml / `MJML` email templating](https://github.com/bitwarden/server/blob/main/src/Core/MailTemplates/Mjml/README.md) +- [Core / MailTemplates / File Types](https://github.com/bitwarden/server/blob/main/src/Core/MailTemplates/README.md) +- [Core / Platform / Mail / Mail Services](https://github.com/bitwarden/server/blob/main/src/Core/Platform/Mail/README.md) +- [Identity / IdentityServer / RequestValidators / SendAccess / **_Important: String Constants_**](https://github.com/bitwarden/server/blob/main/src/Identity/IdentityServer/RequestValidators/SendAccess/readme.md) + +### util + +- [DbSeederUtility / Bitwarden Database Seeder Utility](https://github.com/bitwarden/server/blob/main/util/DbSeederUtility/README.md) +- [Migrator / Bitwarden Database Migrator](https://github.com/bitwarden/server/blob/main/util/Migrator/README.md) +- [MsSqlMigratorUtility / Bitwarden MSSQL Database Migrator Utility](https://github.com/bitwarden/server/blob/main/util/MsSqlMigratorUtility/README.md) +- [MySqlMigrations / Bitwarden MySQL Database Migrator](https://github.com/bitwarden/server/blob/main/util/MySqlMigrations/README.md) +- [PostgresMigrations / Bitwarden PostgreSQL Database Migrator](https://github.com/bitwarden/server/blob/main/util/PostgresMigrations/README.md) +- [Seeder / Bitwarden Database Seeder](https://github.com/bitwarden/server/blob/main/util/Seeder/README.md) +- [SqlServerEFScaffold / README.MD](https://github.com/bitwarden/server/blob/main/util/SqlServerEFScaffold/README.MD) +- [SqliteMigrations / Bitwarden SQLite Database Migrator](https://github.com/bitwarden/server/blob/main/util/SqliteMigrations/README.md) + +## SDK Internal Repository + +README files from [bitwarden/sdk-internal](https://github.com/bitwarden/sdk-internal). + +### bitwarden_license + +- [bitwarden-commercial-vault / Bitwarden Commercial Vault](https://github.com/bitwarden/sdk-internal/blob/main/bitwarden_license/bitwarden-commercial-vault/README.md) +- [bitwarden-sm / bitwarden-sm](https://github.com/bitwarden/sdk-internal/blob/main/bitwarden_license/bitwarden-sm/README.md) + +### crates + +- [bitwarden-api-api / Rust API client for bitwarden-api-api](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-api-api/README.md) +- [bitwarden-api-identity / Rust API client for bitwarden-api-identity](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-api-identity/README.md) +- [bitwarden-auth / Bitwarden Auth](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-auth/README.md) +- [bitwarden-cli / Bitwarden Cli](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-cli/README.md) +- [bitwarden-collections / Bitwarden Collections](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-collections/README.md) +- [bitwarden-core / Bitwarden Core](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-core/README.md) +- [bitwarden-crypto / Bitwarden Cryptographic primitives](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-crypto/README.md) +- [bitwarden-crypto / src / safe / Bitwarden-crypto safe module](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-crypto/src/safe/README.md) +- [bitwarden-encoding / Bitwarden Encoding](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-encoding/README.md) +- [bitwarden-error-macro / Bitwarden Error Macro](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-error-macro/README.md) +- [bitwarden-error / Bitwarden Error](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-error/README.md) +- [bitwarden-exporters / Bitwarden Exporters](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-exporters/README.md) +- [bitwarden-fido / Bitwarden Fido](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-fido/README.md) +- [bitwarden-generators / Bitwarden Generators](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-generators/README.md) +- [bitwarden-ipc / bitwarden-ipc](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-ipc/README.md) +- [bitwarden-pm / Bitwarden Password Manager](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-pm/README.md) +- [bitwarden-policies / Bitwarden Policies](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-policies/README.md) +- [bitwarden-send / Bitwarden Send](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-send/README.md) +- [bitwarden-ssh / Bitwarden SSH](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-ssh/README.md) +- [bitwarden-state / bitwarden-state](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-state/README.md) +- [bitwarden-test / Bitwarden Test](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-test/README.md) +- [bitwarden-threading / bitwarden-threading](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-threading/README.md) +- [bitwarden-uniffi-error / Bitwarden UniFFI error](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uniffi-error/README.md) +- [bitwarden-uniffi / Bitwarden Uniffi](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uniffi/README.md) +- [bitwarden-uniffi / kotlin / Android](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uniffi/kotlin/README.md) +- [bitwarden-uniffi / swift / Swift](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uniffi/swift/README.md) +- [bitwarden-uuid-macro / Bitwarden UUID Macro](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uuid-macro/README.md) +- [bitwarden-uuid / Bitwarden UUID](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-uuid/README.md) +- [bitwarden-vault / Bitwarden Vault](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-vault/README.md) +- [bitwarden-wasm-internal / bitwarden-wasm-internal](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-wasm-internal/README.md) +- [bitwarden-wasm-internal / bitwarden_license / npm / @bitwarden/commercial-sdk-internal](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-wasm-internal/bitwarden_license/npm/README.md) +- [bitwarden-wasm-internal / npm / @bitwarden/sdk-internal](https://github.com/bitwarden/sdk-internal/blob/main/crates/bitwarden-wasm-internal/npm/README.md) +- [bw / Bitwarden CLI (testing)](https://github.com/bitwarden/sdk-internal/blob/main/crates/bw/README.md) + +### support + +- [lints / Bitwarden SDK Lints](https://github.com/bitwarden/sdk-internal/blob/main/support/lints/README.md) + +--- + +_This page is automatically updated by the +[Sync README TOC workflow](https://github.com/bitwarden/contributing-docs/actions/workflows/sync-code-readmes.yml)._ + +_Last updated: 2025-12-14 19:49:06 UTC_ diff --git a/docusaurus.config.js b/docusaurus.config.js index f37996e94..7f7bfcaeb 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -74,6 +74,12 @@ async function createConfig() { label: "Architecture", sidebarId: "architecture", }, + { + type: "docSidebar", + position: "left", + label: "Documentation", + sidebarId: "documentation", + }, { type: "custom-dev", position: "right", diff --git a/sidebars.js b/sidebars.js index 27af065fb..5fa9b8f01 100644 --- a/sidebars.js +++ b/sidebars.js @@ -16,6 +16,7 @@ const sidebars = { getting_started: ["index", { type: "autogenerated", dirName: "getting-started" }], contributing: [{ type: "autogenerated", dirName: "contributing" }], architecture: [{ type: "autogenerated", dirName: "architecture" }], + documentation: [{ type: "autogenerated", dirName: "documentation" }], }; module.exports = sidebars; From 033e1064c0a66cd1a0d05771c9e9e01c2c1c8e9c Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Sun, 14 Dec 2025 15:34:34 -0500 Subject: [PATCH 2/3] Added custom words. --- custom-words.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/custom-words.txt b/custom-words.txt index efaa81957..c7861258c 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -45,6 +45,7 @@ libmagic LLDB Mailcatcher minio +Mjml MVVM NGRX OIDCS @@ -88,6 +89,7 @@ typealias typecheck typechecks typesafe +uniffi unsynchronized WCAG Xcodes.app From 468ca5488dba8370a2c54068b1f072f01819b2fc Mon Sep 17 00:00:00 2001 From: Todd Martin Date: Sun, 14 Dec 2025 16:03:54 -0500 Subject: [PATCH 3/3] Updated markdown. --- docs/documentation/code-readmes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/documentation/code-readmes.md b/docs/documentation/code-readmes.md index 48f677f4c..dc2513a06 100644 --- a/docs/documentation/code-readmes.md +++ b/docs/documentation/code-readmes.md @@ -9,7 +9,7 @@ repositories. ## Clients Repository -README files from [bitwarden/clients](https://github.com/bitwarden/clients). +`README` files from [bitwarden/clients](https://github.com/bitwarden/clients). ### apps @@ -71,7 +71,7 @@ README files from [bitwarden/clients](https://github.com/bitwarden/clients). ## Server Repository -README files from [bitwarden/server](https://github.com/bitwarden/server). +`README` files from [bitwarden/server](https://github.com/bitwarden/server). ### bitwarden_license @@ -101,7 +101,7 @@ README files from [bitwarden/server](https://github.com/bitwarden/server). ## SDK Internal Repository -README files from [bitwarden/sdk-internal](https://github.com/bitwarden/sdk-internal). +`README` files from [bitwarden/sdk-internal](https://github.com/bitwarden/sdk-internal). ### bitwarden_license