Fix/remove w3c cli readme#97
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the 📝 WalkthroughWalkthroughREADME.md undergoes extensive formatting and organizational improvements, including table restructuring, section reorganization, indentation standardization, and content reordering. No functional code changes or control flow modifications are introduced. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
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: 1
🧹 Nitpick comments (1)
README.md (1)
23-40: Use descriptive link text instead of generic "[link]" placeholders.The link text throughout the Getting Started section should be more descriptive to improve accessibility and user experience. Replace generic "[link]" with meaningful text that describes the destination or action.
🔎 Proposed refactor for improved link text
- 1. Generate a signature specific key pair. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key) - 2. Generate and host a DID web identity. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document) + 1. Generate a signature-specific key pair [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key). + 2. Generate and host a DID web identity [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document).And similarly for the remaining sections:
- 1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential) + 1. Prepare and Sign the VC payload [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential).- 1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential) + 1. Verify the signed VC [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential).- 1. Prepare and Sign the payload for Credential Status. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status) + 1. Prepare and Sign the payload for Credential Status [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status).- 1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential) + 1. Prepare and Sign the VC payload [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential).- 1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential) + 1. Verify the signed VC [Learn more](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential).This also addresses the grammar issue flagged at line 23: "signature specific" should be "signature-specific" (hyphenated compound adjective).
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~23-~23: Use a hyphen to join words.
Context: ... Requisite** 1. Generate a signature specific key pair. [link](https://github...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
README.md
23-23: Link text should be descriptive
(MD059, descriptive-link-text)
24-24: Link text should be descriptive
(MD059, descriptive-link-text)
29-29: Link text should be descriptive
(MD059, descriptive-link-text)
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
35-35: Link text should be descriptive
(MD059, descriptive-link-text)
37-37: Link text should be descriptive
(MD059, descriptive-link-text)
39-39: Link text should be descriptive
(MD059, descriptive-link-text)
40-40: No empty links
(MD042, no-empty-links)
40-40: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (1)
README.md (1)
1-48: The w3c-cli references have been successfully removed from the main README. Verification confirms no mentions of w3c-cli exist in README.md. The w3c-cli tool remains available as a separate application in./apps/w3c-cli/, but it is no longer referenced in the primary project documentation.
| 1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential) | ||
| 3. Verify | ||
| 1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential) | ||
| 2. Verify the credentialStatus [link]() |
There was a problem hiding this comment.
Fix the empty link placeholder.
Line 40 contains an incomplete empty link [link]() with no URL. Either provide the complete link or remove the entry if this reference is not yet available.
🔎 Proposed fix
- 2. Verify the credentialStatus [link]()
+ 2. Verify the credentialStatus. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#verify-credential-status)If the URL is unknown, consider removing this bullet point and adding it in a follow-up issue.
📝 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.
| 2. Verify the credentialStatus [link]() | |
| 2. Verify the credentialStatus. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#verify-credential-status) |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
40-40: No empty links
(MD042, no-empty-links)
40-40: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In README.md around line 40, the bullet "Verify the credentialStatus [link]()"
contains an empty link; either replace the empty link with the correct URL to
the referenced documentation/resource, or remove the bracketed link entirely (or
replace it with a TODO/issue reference) so the entry no longer contains an empty
placeholder.
RishabhS7
force-pushed
the
fix/remove-w3c-cli-readme
branch
from
1e4ad58 to
9d1742b
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
40-40: Fix the unresolved empty link placeholder.Line 40 still contains
[link]()with no URL. This must be resolved before merge—either provide the correct link or remove the bullet point entirely.🔎 Proposed fix
Based on the pattern in the document and the context of verifying credential status, either:
- 2. Verify the credentialStatus [link]() + 2. Verify the credentialStatus. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#verify-credential-status)Or, if the reference is not yet available, remove the entry:
- 2. Verify the credentialStatus [link]()
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~23-~23: Use a hyphen to join words.
Context: ... Requisite** 1. Generate a signature specific key pair. [link](https://github...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
README.md
23-23: Link text should be descriptive
(MD059, descriptive-link-text)
24-24: Link text should be descriptive
(MD059, descriptive-link-text)
29-29: Link text should be descriptive
(MD059, descriptive-link-text)
31-31: Link text should be descriptive
(MD059, descriptive-link-text)
35-35: Link text should be descriptive
(MD059, descriptive-link-text)
37-37: Link text should be descriptive
(MD059, descriptive-link-text)
39-39: Link text should be descriptive
(MD059, descriptive-link-text)
40-40: No empty links
(MD042, no-empty-links)
40-40: Link text should be descriptive
(MD059, descriptive-link-text)
| 1. Generate a signature specific key pair. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key) | ||
| 2. Generate and host a DID web identity. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document) |
There was a problem hiding this comment.
Replace generic link text with descriptive alternatives.
Always use descriptive, meaningful text that clearly indicates the link destination. Avoid generic phrases that provide no context about where the link leads. Generic [link] text violates accessibility standards and limits SEO effectiveness.
Replace each generic link with descriptive text based on the surrounding context:
🔎 Proposed fix for all non-descriptive links
1. **Pre Requisite**
- 1. Generate a signature specific key pair. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key)
+ 1. [Generate a signature-specific key pair.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key)
- 2. Generate and host a DID web identity. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document)
+ 2. [Generate and host a DID web identity.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document)
2. **Sign and Verify VC**
1. Sign
- 1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
+ 1. [Prepare and sign the VC payload.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
2. Verify
- 1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)
+ 1. [Verify the signed VC.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)
3. **Sign and Verify VC with Credential Status**
1. Generate Credential Status
- 1. Prepare and Sign the payload for Credential Status. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status)
+ 1. [Prepare and sign the payload for credential status.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status)
2. Sign
- 1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
+ 1. [Prepare and sign the VC payload.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
3. Verify
- 1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)
+ 1. [Verify the signed VC.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)This approach embeds the action verbs directly in the link text, improving both readability and accessibility.
Also applies to: 29-29, 31-31, 35-35, 37-37, 39-39
🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: Use a hyphen to join words.
Context: ... Requisite** 1. Generate a signature specific key pair. [link](https://github...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
23-23: Link text should be descriptive
(MD059, descriptive-link-text)
24-24: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In README.md around lines 23-24 (and also apply the same change at lines 29, 31,
35, 37, 39), replace the generic link text "[link]" with descriptive link text
that reflects the destination and action (for example "Create a
signature-specific key pair" or "Generate and host a DID web identity" or
similar phrasing drawn from the surrounding sentence), update each markdown link
so the visible text is meaningful and actionable for accessibility/SEO, and
ensure the new text remains concise and clear while preserving the original link
URL.
|
1 participant
Summary
Removed the w3c-cli tool mention in readme
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.