chore: converted most html in readme to markdown #371
Conversation
WalkthroughThe README.md was updated to standardize headings and anchors, revise the table of contents links to match new IDs, convert HTML anchors/lists to plain text formats, and make minor text consistency edits across sections and references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
README.md (6)
479-486: Fix shell export: command substitution bug.
$(TMP_ARDRIVE_PW)tries to execute a command. Use variable expansion.read -rs TMP_ARDRIVE_PW -export ARDRIVE_DRIVE_PW=$(TMP_ARDRIVE_PW) +export ARDRIVE_DRIVE_PW="$TMP_ARDRIVE_PW" +# optional: avoid leaving it around +# unset TMP_ARDRIVE_PW ardrive <some private command> -w /path/to/wallet.json -P
253-260: Grammar nit: extra “a”.-To test a with a custom version of the `ardrive-core-js` library on your local system, change the `"ardrive-core-js"` line in `package.json` to the root of your local `ardrive-core-js` repo: +To test with a custom version of the `ardrive-core-js` library on your local system, change the `"ardrive-core-js"` line in `package.json` to the root of your local `ardrive-core-js` repo:
281-286: NPM install command typo.Use either
npm install -gornpm i -g. Current line mixes both.-# then using the path generated by yarn from the step above: -npm install i -g /path/to/package.tgz +# then using the path generated by yarn from the step above: +npm install -g /path/to/package.tgz
540-542: Typos: “entitites” → “entities”.-# List a private drive including the `fileKey` and/or `driveKey` of all listed entitites +# List a private drive including the `fileKey` and/or `driveKey` of all listed entities @@ -In the case of private entitites, the `--with-keys` flag will make the command to include the keys in the output. +In the case of private entities, the `--with-keys` flag will make the command include the keys in the output.Also applies to: 742-747
1051-1054: Duplicate word: “are are”.-[Arweave Path Manifests][arweave-manifests] are are special `.json` files +[Arweave Path Manifests][arweave-manifests] are special `.json` files
1283-1285: Missingardriveprefix and minor grammar.-upload-file --metadata-gql-tags "Custom Tag Name" "Custom Value" # ... +ardrive upload-file --metadata-gql-tags "Custom Tag Name" "Custom Value" # ... @@ - upload-file --metadata-json ' { "json field": "value", "another fields": false } ' # ... +ardrive upload-file --metadata-json ' { "json field": "value", "another field": false } ' # ...Also applies to: 1289-1291
🧹 Nitpick comments (4)
README.md (4)
835-841: Casing consistency: “File”.Match TOC title casing.
-### Download a Single file (BETA) +### Download a Single File (BETA)
430-441: Replace remaining HTML anchors with Markdown subheadings.To fully remove HTML, promote these to subheadings with natural anchors: drive-info, derive-drive-key, derive-file-key, get-share-links, get-total-size, get-file-count, manifest-json.
-The relationship between the drive and its root folder is clearly visible when retrieving the drive's info:<a id='drive-info'></a> +#### Fetching Drive Info +The relationship between the drive and its root folder is clearly visible when retrieving the drive's info: @@ -To derive the drive key again for a drive, perform the following:<a id="derive-drive-key"></a> +#### Derive a Drive Key +To derive the drive key again for a drive, perform the following: @@ -To derive the file key again for a file, perform the following:<a id="derive-file-key"></a> +#### Derive a File Key +To derive the file key again for a file, perform the following: @@ -<a id="get-share-links"></a> +#### Get Share Links for Files in the Drive @@ -<a id="get-total-size"></a> +#### Get Total Size of Files in the Drive @@ -<a id="get-file-count"></a> +#### Get Total Count of Files in the Drive @@ -<a id="manifest-json"></a> +#### Manifest JSONNote: Update TOC link texts if desired; anchor slugs will remain unchanged.
Also applies to: 455-461, 462-468, 551-557, 572-579, 579-585, 1092-1111
1190-1193: Use long option for dest file name (avoid alias confusion).Elsewhere you mention
--dest-file-name. Using-dmay be confused with drive-id in other commands.-ardrive upload-file --remote-path "https://url/to/file" --parent-folder-id "9af694f6-4cfc-4eee-88a8-1b02704760c0" -d "example.jpg" -w /path/to/wallet.json +ardrive upload-file --remote-path "https://url/to/file" --parent-folder-id "9af694f6-4cfc-4eee-88a8-1b02704760c0" --dest-file-name "example.jpg" -w /path/to/wallet.jsonIf
-dis an intended alias here, consider documenting it.
171-175: Audience bullets: capitalization consistency.Optional: capitalize “NFT” and consider “Sysadmins” or “database admins”.
-- ArDrive power users with advanced workflows and resource efficiency in mind: bulk uploaders, those with larger storage demand, game developers, nft creators, storage/db admins, etc. +- ArDrive power users with advanced workflows and resource efficiency in mind: bulk uploaders, those with larger storage demand, game developers, NFT creators, storage/db admins, etc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(32 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~171-~171: There might be a mistake here.
Context: ...s, nft creators, storage/db admins, etc. - Automation tools - Services - Terminal a...
(QB_NEW_EN)
[grammar] ~172-~172: There might be a mistake here.
Context: ...orage/db admins, etc. - Automation tools - Services - Terminal aficionados - Extant...
(QB_NEW_EN)
[grammar] ~173-~173: There might be a mistake here.
Context: ...mins, etc. - Automation tools - Services - Terminal aficionados - Extant and aspiri...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ... tools - Services - Terminal aficionados - Extant and aspiring cypherpunks For dee...
(QB_NEW_EN)
[grammar] ~379-~379: There might be a mistake here.
Context: ...y types specified by ArFS are: - Drives - Folders - Files Each instance of these ...
(QB_NEW_EN)
[grammar] ~380-~380: There might be a mistake here.
Context: ...ecified by ArFS are: - Drives - Folders - Files Each instance of these entities h...
(QB_NEW_EN)
[grammar] ~450-~450: There might be a mistake here.
Context: ...Drive ID, User-specified Drive Password) - File Key = functionOf(Randomly Generated...
(QB_NEW_EN)
[grammar] ~475-~475: There might be a mistake here.
Context: ... supplying them: - Environment Variable - STDIN - Secure Prompt #### Supplying Yo...
(QB_NEW_EN)
[grammar] ~476-~476: There might be a mistake here.
Context: ...ng them: - Environment Variable - STDIN - Secure Prompt #### Supplying Your Passw...
(QB_NEW_EN)
[grammar] ~859-~859: There might be a mistake here.
Context: ...d will reconstruct the folder hierarchy on local disk as ArFS folders on the perma...
(QB_NEW_EN)
[grammar] ~1395-~1395: Use a hyphen to join words.
Context: .... NOTE: Your cold wallet won't appear on chain until it has received AR. The wor...
(QB_NEW_EN_HYPHEN)
[grammar] ~1399-~1399: There might be a mistake here.
Context: ...y string if none has ever been sent out) - the base fee for an Arweave transaction ...
(QB_NEW_EN)
🔇 Additional comments (1)
README.md (1)
79-89: Anchors validated: all TOC links resolve. No missing anchors detected.
| The best cold wallet storage never exposes your seed phrase and/or private keys to the Internet or a compromised system interface. You can use the ArDrive CLI to facilitate cold storage and transfer of AR. | ||
| If you need a new cold AR wallet, generate one from an air-gapped machine capable of running the ArDrive CLI by following the instructions in the [Wallet Operations](#wallet-operations) section. Fund your cold wallet from whatever external sources you'd like. NOTE: Your cold wallet won't appear on chain until it has received AR. | ||
| The workflow to send the AR out from your cold wallet requires you to generate a signed transaction with your cold wallet on your air-gapped machine via the ArDrive CLI, and then to transfer the signed transaction (e.g. by a file on a clean thumb drive) to an Internet-connected machine and send the transaction to the network via the ArDrive CLI. You'll need two inputs from the Internet-connected machine: | ||
There was a problem hiding this comment.
Hyphenation: “on-chain”.
-NOTE: Your cold wallet won't appear on chain until it has received AR.
+NOTE: Your cold wallet won't appear on-chain until it has received AR.📝 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.
| The best cold wallet storage never exposes your seed phrase and/or private keys to the Internet or a compromised system interface. You can use the ArDrive CLI to facilitate cold storage and transfer of AR. | |
| If you need a new cold AR wallet, generate one from an air-gapped machine capable of running the ArDrive CLI by following the instructions in the [Wallet Operations](#wallet-operations) section. Fund your cold wallet from whatever external sources you'd like. NOTE: Your cold wallet won't appear on chain until it has received AR. | |
| The workflow to send the AR out from your cold wallet requires you to generate a signed transaction with your cold wallet on your air-gapped machine via the ArDrive CLI, and then to transfer the signed transaction (e.g. by a file on a clean thumb drive) to an Internet-connected machine and send the transaction to the network via the ArDrive CLI. You'll need two inputs from the Internet-connected machine: | |
| The best cold wallet storage never exposes your seed phrase and/or private keys to the Internet or a compromised system interface. You can use the ArDrive CLI to facilitate cold storage and transfer of AR. | |
| If you need a new cold AR wallet, generate one from an air-gapped machine capable of running the ArDrive CLI by following the instructions in the [Wallet Operations](#wallet-operations) section. Fund your cold wallet from whatever external sources you'd like. NOTE: Your cold wallet won't appear on-chain until it has received AR. | |
| The workflow to send the AR out from your cold wallet requires you to generate a signed transaction with your cold wallet on your air-gapped machine via the ArDrive CLI, and then to transfer the signed transaction (e.g. by a file on a clean thumb drive) to an Internet-connected machine and send the transaction to the network via the ArDrive CLI. You'll need two inputs from the Internet-connected machine: |
🧰 Tools
🪛 LanguageTool
[grammar] ~1395-~1395: Use a hyphen to join words.
Context: .... NOTE: Your cold wallet won't appear on chain until it has received AR. The wor...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In README.md around lines 1393 to 1398, the phrase "on chain" is hyphenated
incorrectly; replace "on chain" with the hyphenated form "on-chain" (e.g.,
change "Your cold wallet won't appear on chain until it has received AR." to
"Your cold wallet won't appear on-chain until it has received AR.") and scan the
surrounding sentences for any other instances of "on chain" to update for
consistent hyphenation.
| - the last transaction sent OUT from the cold wallet (or an empty string if none has ever been sent out) | ||
| - the base fee for an Arweave transaction (i.e. a zero bye transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction. | ||
There was a problem hiding this comment.
Typo: “zero bye” → “zero byte”.
-- the base fee for an Arweave transaction (i.e. a zero bye transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction.
+- the base fee for an Arweave transaction (i.e. a zero byte transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction.📝 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.
| - the last transaction sent OUT from the cold wallet (or an empty string if none has ever been sent out) | |
| - the base fee for an Arweave transaction (i.e. a zero bye transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction. | |
| - the last transaction sent OUT from the cold wallet (or an empty string if none has ever been sent out) | |
| - the base fee for an Arweave transaction (i.e. a zero byte transaction). Note that this value could change if a sufficient amount of time passes between the time you fetch this value, create the transaction, and send the transaction. |
🧰 Tools
🪛 LanguageTool
[grammar] ~1399-~1399: There might be a mistake here.
Context: ...y string if none has ever been sent out) - the base fee for an Arweave transaction ...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In README.md around lines 1399 to 1401 the phrase "zero bye transaction" is a
typo; change "bye" to "byte" so the line reads "the base fee for an Arweave
transaction (i.e. a zero byte transaction)." Update that single word and
preserve the rest of the sentence and punctuation.
Summary by CodeRabbit