Update fundamentals/certification-system #410
Conversation
WalkthroughDocumentation updates expand the TGWUI guide with a Support section, extensively rewrite the certification system documentation to describe a three-level CA hierarchy and hardware-rooted trust model, and add tooltip components for TEE Confirmation Block and Trusted Loader to the layout. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/fundamentals/certification.md`:
- Around line 31-34: The anchor id on the CVM link currently reuses id="ca",
which conflicts with the CA anchor and prevents the `#cvm` tooltip from working;
update the anchor id to match the tooltip selector (e.g., change id="ca" to
id="cvm") on the Confidential Virtual Machines link while preserving the
existing span and className="dashed-underline" and link text so
cross-referencing follows the established pattern.
In `@src/theme/Layout/index.js`:
- Line 96: The JSX contains a raw line comment "// Stabs and abbreviations"
which renders as text and trips the linter; update that inline comment in the
JSX to a proper JSX comment by replacing the raw // comment with a wrapped
comment like {/* Stabs and abbreviations */} so it becomes a valid JSX
expression (locate the JSX fragment containing "Stabs and abbreviations" and
change the comment syntax accordingly).
| - Root CA is the top-level certificate authority that establishes the trust anchor for the entire system. At the start, it generates a self-signed certificate, embedding the SGX attestation quote. | ||
| - SubRoot CAs are intermediate certificate authorities. They submit their quotes and public keys to the Root CA and request certificates. The Root CA verifies these incoming requests and then issues and signs certificates for the SubRoot CAs. Once a SubRoot CA is certified by the Root CA, it can certify any TEE-backed environment that proves it is actually confidential. | ||
| - End certificates are issued to specific workloads, entire <a id="ca"><span className="dashed-underline">Confidential Virtual Machines</span></a> (CVMs) running in TEEs, and in some other cases. These certificates are not CAs and cannot be used to sign or issue other certificates. | ||
|
|
There was a problem hiding this comment.
Fix the CVM anchor id to match the tooltip selector.
Right now the CVM link uses id="ca", which duplicates the CA anchor and breaks the #cvm tooltip.
🔧 Proposed fix
-- End certificates are issued to specific workloads, entire <a id="ca"><span className="dashed-underline">Confidential Virtual Machines</span></a> (CVMs) running in TEEs, and in some other cases. These certificates are not CAs and cannot be used to sign or issue other certificates.
+- End certificates are issued to specific workloads, entire <a id="cvm"><span className="dashed-underline">Confidential Virtual Machines</span></a> (CVMs) running in TEEs, and in some other cases. These certificates are not CAs and cannot be used to sign or issue other certificates.🤖 Prompt for AI Agents
In `@docs/fundamentals/certification.md` around lines 31 - 34, The anchor id on
the CVM link currently reuses id="ca", which conflicts with the CA anchor and
prevents the `#cvm` tooltip from working; update the anchor id to match the
tooltip selector (e.g., change id="ca" to id="cvm") on the Confidential Virtual
Machines link while preserving the existing span and
className="dashed-underline" and link text so cross-referencing follows the
established pattern.
| Trusted Loader generates and publishes TCB on the blockchain every 24 hours. | ||
| </Tooltip> | ||
|
|
||
| // Stabs and abbreviations |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# First, examine the file at and around line 96
sed -n '90,105p' src/theme/Layout/index.jsRepository: Super-Protocol/docs
Length of output: 621
🏁 Script executed:
#!/bin/bash
# Also check if the file exists and its total line count
wc -l src/theme/Layout/index.jsRepository: Super-Protocol/docs
Length of output: 92
🏁 Script executed:
#!/bin/bash
# Search for the specific comment
rg -n 'Stabs and abbreviations' src/theme/Layout/index.jsRepository: Super-Protocol/docs
Length of output: 98
🏁 Script executed:
#!/bin/bash
# Check how comments are handled in the custom components mentioned in learnings
fd -type f -path 'src/theme/*' \( -name '*.tsx' -o -name '*.ts' -o -name '*.jsx' -o -name '*.js' \) | head -20Repository: Super-Protocol/docs
Length of output: 233
🏁 Script executed:
#!/bin/bash
# List files in src/theme to find custom components
find src/theme -type f -name '*.tsx' -o -name '*.ts' -o -name '*.jsx' -o -name '*.js'Repository: Super-Protocol/docs
Length of output: 425
🏁 Script executed:
#!/bin/bash
# Check for Biome configuration
find . -maxdepth 2 -name 'biome.json*' -o -name '.biomerc*'Repository: Super-Protocol/docs
Length of output: 75
🏁 Script executed:
#!/bin/bash
# Search for Highlight, Imager, and Admonition components
rg -l '(Highlight|Imager|Admonition)' src/theme --type js --type ts --type jsx --type tsxRepository: Super-Protocol/docs
Length of output: 90
🏁 Script executed:
#!/bin/bash
# Check for similar // comment patterns inside JSX in the file
rg -n '^\s*//\s+' src/theme/Layout/index.jsRepository: Super-Protocol/docs
Length of output: 98
🏁 Script executed:
#!/bin/bash
# Get broader context around line 96 to see full JSX structure
sed -n '85,106p' src/theme/Layout/index.jsRepository: Super-Protocol/docs
Length of output: 1007
🏁 Script executed:
#!/bin/bash
# Check Highlight.jsx for comment patterns
cat -n src/theme/Highlight.jsxRepository: Super-Protocol/docs
Length of output: 500
🏁 Script executed:
#!/bin/bash
# Check Imager.jsx for comment patterns
cat -n src/theme/Imager.jsxRepository: Super-Protocol/docs
Length of output: 349
🏁 Script executed:
#!/bin/bash
# Check biome.json configuration
cat -n biome.jsonRepository: Super-Protocol/docs
Length of output: 2348
🏁 Script executed:
#!/bin/bash
# Check Admonition layout for comment patterns
cat -n src/theme/Admonition/Layout/index.tsxRepository: Super-Protocol/docs
Length of output: 1904
Wrap the JSX comment in braces. A raw // comment inside JSX renders as text and triggers the lint error flagged by Biome.
🛠️ Proposed fix
- // Stabs and abbreviations
+ {/* Stabs and abbreviations */}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Stabs and abbreviations | |
| {/* Stabs and abbreviations */} |
🧰 Tools
🪛 Biome (2.1.2)
[error] 96-98: Wrap comments inside children within braces.
Unsafe fix: Wrap the comments with braces
(lint/suspicious/noCommentText)
🤖 Prompt for AI Agents
In `@src/theme/Layout/index.js` at line 96, The JSX contains a raw line comment
"// Stabs and abbreviations" which renders as text and trips the linter; update
that inline comment in the JSX to a proper JSX comment by replacing the raw //
comment with a wrapped comment like {/* Stabs and abbreviations */} so it
becomes a valid JSX expression (locate the JSX fragment containing "Stabs and
abbreviations" and change the comment syntax accordingly).
Summary by CodeRabbit
Documentation
New Features
✏️ Tip: You can customize this high-level summary in your review settings.