Skip to content

docs: expand README with deployment/API guidance and fix spec typo#102

Merged
hsiuhsiu merged 1 commit intomasterfrom
fix/doc
Mar 26, 2026
Merged

docs: expand README with deployment/API guidance and fix spec typo#102
hsiuhsiu merged 1 commit intomasterfrom
fix/doc

Conversation

@hsiuhsiu
Copy link
Copy Markdown
Contributor

  • Add "What cb-mpc Does and Does Not Do" section clarifying library scope
  • Add "Supported Runtime and Deployment Environments" section covering supported platforms and integrator responsibilities for transport, secret storage, and process isolation
  • Add "Key Management Responsibilities" section documenting key blob lifecycle, backup/restore guidance, and refresh/rotation semantics
  • Add "High-level Public API vs the Full API" and "Building the Code" entries to the table of contents
  • Fix spec reference typo in commitment.h: Comp-1P → Com-1P

Addresses #64, #77, #78, #79, #80, #83

- Add "What cb-mpc Does and Does Not Do" section clarifying library scope
- Add "Supported Runtime and Deployment Environments" section covering
  supported platforms and integrator responsibilities for transport,
  secret storage, and process isolation
- Add "Key Management Responsibilities" section documenting key blob
  lifecycle, backup/restore guidance, and refresh/rotation semantics
- Add "High-level Public API vs the Full API" and "Building the Code"
  entries to the table of contents
- Fix spec reference typo in commitment.h: Comp-1P → Com-1P

Addresses #64, #77, #78, #79, #80, #83
@cb-heimdall
Copy link
Copy Markdown

cb-heimdall commented Mar 26, 2026

✅ Heimdall Review Status

Requirement Status More Info
Reviews 2/2
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 2
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 1
Global minimum 0
Max 2
2
1 if commit is unverified 0
Sum 2
CODEOWNERS ✅ None for this change

@hsiuhsiu hsiuhsiu marked this pull request as ready for review March 26, 2026 17:08
Copy link
Copy Markdown

@valery-osheter-cb valery-osheter-cb left a comment

Choose a reason for hiding this comment

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

Approved

@hsiuhsiu hsiuhsiu merged commit 3217a88 into master Mar 26, 2026
9 checks passed
@hsiuhsiu hsiuhsiu deleted the fix/doc branch March 26, 2026 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants