docs: v23 gui updates #535
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (2)
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 WalkthroughAdded password-setting and mnemonic backup/verification steps to Dash Core wallet creation guides for Linux, macOS, and Windows; expanded the governance docs with a comprehensive Dash Core Wallet workflow for creating and submitting proposals, and added a Dash Budget Proposal Generator and console workflow. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Wallet as Dash Core Wallet
User->>Wallet: Start "Create Wallet"
rect `#E6F0FF`
Note over User,Wallet: Setting your password
User->>Wallet: Choose "Encrypt wallet now"
Wallet->>User: Prompt: enter password
User->>Wallet: Enter & confirm password
Wallet->>User: Show encryption confirmation ("Yes" to continue)
end
rect `#EBFFEA`
Note over User,Wallet: Backing up your mnemonic
Wallet->>User: Display recovery mnemonic + critical warning
User->>Wallet: Reveal & write down mnemonic
Wallet->>User: Prompt: verify mnemonic words
User->>Wallet: Enter words → Wallet: update progressive checks
Wallet->>User: Verification success
end
User->>Wallet: Finish wallet creation
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ 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)
docs/user/wallets/dashcore/installation-linux.rst (1)
224-224: Minor: Consider harmonizing phrasing for consistency across platforms.Line 224 adds an explicit instruction "Click Yes to continue" after the encryption warning. The macOS (line 185) and Windows (line 233) guides use the phrasing "Following that, you will get a standard warning" without the explicit click instruction.
If the Linux Dash Core GUI displays a "Yes" button while macOS/Windows display a different button label or interaction pattern, then the platform-specific phrasing is appropriate. Otherwise, consider harmonizing for consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
docs/user/wallets/dashcore/img/linux/dash-mnemonic-save-confirm.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/linux/dash-mnemonic-save-show.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/linux/dash-mnemonic-save.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/macos/dash-mnemonic-save-confirm.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/macos/dash-mnemonic-save-show.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/macos/dash-mnemonic-save.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/user/wallets/dashcore/installation-linux.rst(1 hunks)docs/user/wallets/dashcore/installation-macos.rst(2 hunks)docs/user/wallets/dashcore/installation-windows.rst(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Learnt from: thephez
Repo: dashpay/docs PR: 534
File: locale/en/LC_MESSAGES/docs/user/masternodes/maintenance.po:175-176
Timestamp: 2025-11-12T18:09:41.377Z
Learning: In the dashpay/docs repository, .po files under locale/ directories are automated outputs generated by running the transifex/pushtx.sh script. These files should not be manually edited as changes will be overwritten on the next Transifex sync. Any corrections should be made at the source level in the original documentation files or within Transifex.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/wallets/dashcore/installation-windows.rstdocs/user/wallets/dashcore/installation-linux.rstdocs/user/wallets/dashcore/installation-macos.rst
📚 Learning: 2025-11-10T19:11:33.355Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
Applied to files:
docs/user/wallets/dashcore/installation-windows.rstdocs/user/wallets/dashcore/installation-linux.rstdocs/user/wallets/dashcore/installation-macos.rst
🔇 Additional comments (2)
docs/user/wallets/dashcore/installation-macos.rst (1)
175-235: ✓ New mnemonic backup and password setting sections look good.The new subsections ("Setting your password" and "Backing up your mnemonic") are well-structured with appropriate warnings, clear instructions, helpful figures, and cross-references to HD wallet information. Content is consistent with the concurrent macOS user experience, and image paths correctly use the
img/macos/prefix throughout.docs/user/wallets/dashcore/installation-linux.rst (1)
214-276: ✓ New password and mnemonic sections well-structured with proper anchors.The "Setting your password" and "Backing up your mnemonic" subsections follow the same clear structure as the macOS and Windows guides, with consistent warnings, step-by-step instructions, and cross-references. Image paths correctly use
img/linux/. The addition of the anchor_dashcore-wallet-mnemonic-backupat line 231 supports cross-referencing, which is helpful for internal documentation links.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
docs/user/governance/img/core-qt/governance-tab.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-create.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-prepare-burned-conf-wait.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-prepare-burned.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-submit-awaiting.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-submitted-conf.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-submitted.pngis excluded by!**/*.pngdocs/user/governance/img/core-qt/proposal-validate.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/user/governance/using.rst(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
Learnt from: thephez
Repo: dashpay/docs PR: 534
File: locale/en/LC_MESSAGES/docs/user/masternodes/maintenance.po:175-176
Timestamp: 2025-11-12T18:09:41.377Z
Learning: In the dashpay/docs repository, .po files under locale/ directories are automated outputs generated by running the transifex/pushtx.sh script. These files should not be manually edited as changes will be overwritten on the next Transifex sync. Any corrections should be made at the source level in the original documentation files or within Transifex.
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/governance/using.rst
📚 Learning: 2025-11-10T17:22:58.160Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Applied to files:
docs/user/governance/using.rst
🔇 Additional comments (1)
docs/user/governance/using.rst (1)
231-358: Well-organized GUI workflow with clear step-by-step instructions.The new Dash Core Wallet section provides an excellent user-friendly alternative to console commands and external tools. The workflow is logically structured, includes appropriate warnings about irreversible transactions, and integrates smoothly with the existing console-based approach documented below.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/user/wallets/dashcore/img/macos/dash-mnemonic-save-confirm.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/macos/dash-mnemonic-save-show.pngis excluded by!**/*.pngdocs/user/wallets/dashcore/img/macos/dash-mnemonic-save.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/user/governance/using.rst(3 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1702-1704
Timestamp: 2025-11-10T19:11:33.355Z
Learning: Repo: dashpay/docs — For ListDescriptors RPC, document Parameter #1 `private` (bool, default false) and note that `mnemonic` and `mnemonicpassphrase` appear only when `private=true` and the wallet was created with a mnemonic. Both fields are strings per Dash Core v23.0 help (scripts/core-rpc-tools/dash-cli-help-23.0.0.jsonl).
Learnt from: thephez
Repo: dashpay/docs PR: 534
File: locale/en/LC_MESSAGES/docs/user/masternodes/maintenance.po:175-176
Timestamp: 2025-11-12T18:09:41.377Z
Learning: In the dashpay/docs repository, .po files under locale/ directories are automated outputs generated by running the transifex/pushtx.sh script. These files should not be manually edited as changes will be overwritten on the next Transifex sync. Any corrections should be made at the source level in the original documentation files or within Transifex.
📚 Learning: 2025-11-10T18:51:37.016Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-calls-wallet.md:1737-1738
Timestamp: 2025-11-10T18:51:37.016Z
Learning: Repo: dashpay/docs — When examples show dash-cli command output, keep them verbatim (do not remove or tweak fields for clarity), even if multiple versions of a field (e.g., "next" and "next_index") appear. Applies across API docs, including docs/core/api/remote-procedure-calls-wallet.md.
Applied to files:
docs/user/governance/using.rst
📚 Learning: 2025-11-10T17:22:58.160Z
Learnt from: thephez
Repo: dashpay/docs PR: 525
File: docs/core/api/remote-procedure-call-quick-reference.md:34-34
Timestamp: 2025-11-10T17:22:58.160Z
Learning: In the dashpay/docs repository, RPC documentation descriptions in files like `docs/core/api/remote-procedure-call-quick-reference.md` are derived from the Dash Core application help output. These descriptions should not be modified for grammar or style, as they need to remain consistent with the source application output.
Applied to files:
docs/user/governance/using.rst
🔇 Additional comments (7)
docs/user/governance/using.rst (7)
61-61: Proposal name limit correctly updated to 40 characters.This change is consistently reflected across the document (line 289 also states 40 characters), aligning with the updated constraint.
143-148: Well-structured introduction directing users to three proposal creation methods.The rewrite clearly presents the three pathways (GUI, console, generator) and provides proper cross-references. This improves discoverability compared to prior versions.
149-278: Comprehensive GUI workflow with clear step-by-step guidance and appropriate warnings.The new Dash Core Wallet GUI section is well-structured, beginning with tab access through proposal submission. Warnings about irreversible 1 DASH fees are prominently placed before critical actions (line 208-212, 223). The narrative flows logically from field entry through validation and confirmation. Cross-reference to DashCentral at line 276 is helpful context. Note: verify that all 10 referenced figure files exist in the repository before merging.
279-350: Generator section is well-documented and consistent with collateral requirements.This section maintains the original generator workflow while fitting into the new multi-method structure. The 6-confirmation requirement (line 323) aligns with console section expectations. Operational steps (unlock, console access, command paste) are clear. Note: verify figure files at lines 301-343 exist.
352-459: Console workflow section is comprehensive and well-documented with clear command examples.The new Dash Core Wallet Console section provides a detailed walkthrough from JSON assembly through hex serialization to command submission. Example outputs (transaction IDs and governance object IDs at lines 431 and 458) follow SHA-256 format and should be kept verbatim per documentation guidelines. Cross-references to Core RPC documentation are properly formatted. The 6-confirmation requirement (line 436) aligns with generator section. All command parameters are clearly explained.
460-565: Voting section properly presents multiple voting methods with clear instructions.The updated voting section now references DashCentral, Dash Ninja, and DMT equally, providing users with multiple voting pathways. The 3-day deadline (1662 blocks) is clearly stated at lines 463-465. All voting option examples (yes/abstain/no) are present and properly formatted. The helpful note at line 558 distinguishing vote-many from vote adds necessary nuance for operators with multiple masternodes.
1-585: Overall structure and consistency: well-organized multi-method documentation with proper cross-referencing.The file successfully documents three governance proposal submission workflows (GUI, console, generator) with consistent messaging across all three methods regarding the 1 DASH collateral fee, confirmation requirements, and proposal ID tracking. Cross-reference anchors are properly defined and linked. The voting section has been appropriately expanded to reference multiple voting platforms. Documentation flows logically from proposal creation theory, through three submission methods, to voting execution.
1 participant
Preview build: https://dash-docs--535.org.readthedocs.build/en/535/
Summary by CodeRabbit