README improvements

[harr1424]

📔 Objective

Improve README to provide greater detail on the process of generating API bindings.

⏰ 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

• 👍 (:+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

[claude]

Claude finished @harr1424's task in 2m 1s —— View job

---

Code Review Complete

• Starting code review
• Analyzing changes
• Posting review comments

Summary

Overall Assessment: ✅ APPROVE

The documentation improvements are accurate and helpful. The PR correctly documents:

• The requirement for both server and sdk-internal repos to share the same parent directory
• The specific files needed (api.json and identity.json)
• That the build-api.sh script reads files directly from ../server/ (no manual copying required)

The initial error suggesting manual file copying was correctly fixed following dani-garcia's feedback.

[github-actions]

Checkmarx One – Scan Summary & Details – 1e3d6edf-902a-41cc-84ce-686c7fc286b3

Great job! No new security vulnerabilities introduced in this pull request

[github-actions]

🔍 SDK Breaking Change Detection Results

SDK Version: doc-improvement-12-25 (efb5139)
Completed: 2025-12-19 14:22:19 UTC
Total Time: 245s

Client	Status	Details
typescript	✅ No breaking changes detected	TypeScript compilation passed with new SDK version - View Details

---

Breaking change detection completed. View SDK workflow

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.85%. Comparing base (0a9599e) to head (efb5139).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #622      +/-   ##
==========================================
+ Coverage   78.54%   78.85%   +0.31%     
==========================================
  Files         283      283              
  Lines       29251    29625     +374     
==========================================
+ Hits        22975    23362     +387     
+ Misses       6276     6263      -13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[dani-garcia]

The files that we need are api.json and identity.json, and there's no need to copy them, the script reads them from the server folder directly as long as the server and sdk folders are at the same directory:

sdk-internal/support/build-api.sh

Lines 10 to 11 in 0a9599e

	cp ../server/api.json ./artifacts/api.json
	cp ../server/identity.json ./artifacts/identity.json

[Hinton]

We should mention somewhere that you should only use the workflow and never merge manual binding changes in PRs.

https://github.com/bitwarden/sdk-internal/actions/workflows/update-api-bindings.yml

[harr1424]

@Hinton please let me know what you think of the wording in efb5139