feat(docs): Docs site restructure and new content #468
Conversation
WalkthroughWalkthroughThe changes encompass updates to documentation links for clarity and consistency, the introduction of new documentation files covering a wide array of topics, and significant semantic updates to existing files. These revisions simplify navigation, enhance understanding, and refine terminology related to smart contracts and key management within the Warden Protocol. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
jjheywood
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 45
Outside diff range and nitpick comments (6)
docs/README.md (1)
Line range hint
1-41: Correct heading levels and specify language for code blocks.The document uses incorrect heading levels and lacks language specification for code blocks, which could lead to formatting issues on some Markdown renderers.
- ### Install + ## Install - ### Devlop locally + ## Develop locally - ### Deploy + ## Deploy + ```bash $ yarn
$ yarn start
+ ```bash $ yarn build
$ USE_SSH=true yarn deploy
+ ```bash $ GIT_USER=<Your GitHub username> yarn deploy<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 5-5: Expected: h2; Actual: h3 Heading levels should only increment by one level at a time (MD001, heading-increment) --- 8-8: null Dollar signs used before commands without showing output (MD014, commands-show-output) --- 14-14: null Dollar signs used before commands without showing output (MD014, commands-show-output) --- 7-7: null Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 13-13: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> <details> <summary>README.md (1)</summary><blockquote> Line range hint `1-15`: **Improve clarity and correct Markdown formatting.** The document could use more precise language to strengthen the statements. Additionally, address the multiple blank lines and the use of a bare URL. ```diff - out the [documentation website](https://docs.wardenprotocol.org/). + out the [documentation website](https://docs.wardenprotocol.org/) for detailed documentation. - If you're going to contribute to the protocol, see [protocol developer docs on GitHub](protocol-developer-docs). + If you're interested in contributing to the protocol, see the [protocol developer docs on GitHub](protocol-developer-docs). -Tools
LanguageTool
[style] ~8-~8: Consider using an alternative to strengthen your wording.
Context: ...t: https://wardenprotocol.org/. If you want to learn more, join the network or cont...(WANT_KEEN)
Markdownlint
13-13: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
6-6: null
Bare URL used(MD034, no-bare-urls)
docs/docs/help-center/ward-token/ward.md (1)
Line range hint
26-26: Add hyphen to compound adjective.For clarity and correct grammar, "product-market fit" should be hyphenated.
- a phase of maturity where Warden’s core product market fit has been established and a period of long term predictable incentives and monetary policy are curated by the community. + a phase of maturity where Warden’s core product-market fit has been established and a period of long-term predictable incentives and monetary policy are curated by the community.Tools
Markdownlint
19-19: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
24-24: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
docs/docs/help-center/ward-token/demand.md (1)
Line range hint
27-27: Remove extra blank lines.Multiple consecutive blank lines found in the markdown file which should be removed for consistency and to adhere to markdown standards.
- \n - \nTools
LanguageTool
[uncategorized] ~21-~21: When a number forms part of an adjectival compound, use a hyphen.
Context: ...locked and can only be unbonded after a 6 month notice period. ## Validator bonds To ...(MISSING_HYPHEN)
Markdownlint
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
19-19: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
docs/docs/learn/whitepaper.md (2)
Line range hint
37-37: Grammatical corrections needed.Consider adding commas to improve readability and flow in the descriptions of OApps.
- Owing to this OApps can achieve remarkable features: ... + Owing to this, OApps can achieve remarkable features: ... - ... to other chains which enables a host of completely new use cases enabled by OApps. + ... to other chains, which enables a host of entirely new use cases enabled by OApps.Also applies to: 43-43
Tools
Markdownlint
13-13: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
Line range hint
49-49: Grammatical corrections needed in the security stack section.A few minor grammatical adjustments will enhance the clarity of this section.
- _Figure 1: Warden Protocols modular architecture unbundles the application layer for greater and more resilient security_ + _Figure 1: Warden Protocol's modular architecture unbundles the application layer for greater and more resilient security_ - ... an application on Optimism has a 7 day dispute delay window which cannot be ignored ... + ... an application on Optimism has a 7-day dispute delay window which cannot be ignored ...Also applies to: 53-53
Tools
Markdownlint
13-13: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (2)
docs/docs/build-an-oapp/test/metamask-snap-accounts-preview.jpgis excluded by!**/*.jpgdocs/static/img/metamask-snap-accounts-preview.jpgis excluded by!**/*.jpg
Files selected for processing (54)
- README.md (2 hunks)
- docs/.spelling (3 hunks)
- docs/Overview.md (1 hunks)
- docs/README.md (3 hunks)
- docs/docs/build-a-keychain/examples/category.json (1 hunks)
- docs/docs/build-a-keychain/examples/clichain.md (1 hunks)
- docs/docs/build-a-keychain/examples/warden-kms.md (1 hunks)
- docs/docs/build-a-keychain/introduction.md (1 hunks)
- docs/docs/build-a-keychain/keychain-sdk.md (1 hunks)
- docs/docs/build-a-keychain/quick-start.md (1 hunks)
- docs/docs/build-an-oapp/build-a-custom-smart-contract.md (1 hunks)
- docs/docs/build-an-oapp/build-the-frontend/category.json (1 hunks)
- docs/docs/build-an-oapp/build-the-frontend/quick-start.md (1 hunks)
- docs/docs/build-an-oapp/build-the-frontend/wardenjs-functions.md (1 hunks)
- docs/docs/build-an-oapp/build-the-frontend/wardenui-components.md (1 hunks)
- docs/docs/build-an-oapp/build-with-wardenjs.md (1 hunks)
- docs/docs/build-an-oapp/introduction.md (1 hunks)
- docs/docs/build-an-oapp/quick-start.md (1 hunks)
- docs/docs/build-an-oapp/smart-contract-api-reference.md (1 hunks)
- docs/docs/build-an-oapp/test/category.json (1 hunks)
- docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (5 hunks)
- docs/docs/build-an-oapp/test/run-a-local-chain.md (5 hunks)
- docs/docs/build-an-oapp/useful-links.md (1 hunks)
- docs/docs/help-center/buenavista-quick-start.md (1 hunks)
- docs/docs/help-center/connect-your-wallet.md (1 hunks)
- docs/docs/help-center/create-a-space.md (1 hunks)
- docs/docs/help-center/enable-metamask-snap.md (1 hunks)
- docs/docs/help-center/get-test-ward.md (1 hunks)
- docs/docs/help-center/introduction.md (1 hunks)
- docs/docs/help-center/manage-intents.md (1 hunks)
- docs/docs/help-center/request-a-new-key.md (1 hunks)
- docs/docs/help-center/use-dapps.md (1 hunks)
- docs/docs/help-center/use-the-block-explorer.md (1 hunks)
- docs/docs/help-center/use-walletconnect.md (1 hunks)
- docs/docs/help-center/ward-token/category.json (1 hunks)
- docs/docs/help-center/ward-token/airdrop-stages.md (2 hunks)
- docs/docs/help-center/ward-token/demand.md (1 hunks)
- docs/docs/help-center/ward-token/distribution.md (1 hunks)
- docs/docs/help-center/ward-token/incentives.md (1 hunks)
- docs/docs/help-center/ward-token/supply.md (1 hunks)
- docs/docs/help-center/ward-token/ward.md (1 hunks)
- docs/docs/help-center/warp-token/category.json (1 hunks)
- docs/docs/help-center/warp-token/bridge-base.md (1 hunks)
- docs/docs/help-center/warp-token/warp.md (1 hunks)
- docs/docs/learn/glossary.md (1 hunks)
- docs/docs/learn/introduction-to-warden.md (1 hunks)
- docs/docs/learn/request-flow.md (1 hunks)
- docs/docs/learn/warden-protocol-modules/category.json (1 hunks)
- docs/docs/learn/warden-protocol-modules/introduction.md (1 hunks)
- docs/docs/learn/warden-protocol-modules/x-act.md (1 hunks)
- docs/docs/learn/warden-protocol-modules/x-warden.md (1 hunks)
- docs/docs/learn/whitepaper.md (1 hunks)
- docs/docs/operate-a-node/create-a-validator.md (1 hunks)
- docs/docs/operate-a-node/delegation-plan.md (1 hunks)
Files not processed due to max files limit (26)
- docs/docs/operate-a-node/introduction.md
- docs/docs/operate-a-node/networks/category.json
- docs/docs/operate-a-node/networks/available-networks.md
- docs/docs/operate-a-node/networks/join-buenavista.md
- docs/docs/operate-a-node/node-api-reference.md
- docs/docs/validate/creating-validator.md
- docs/docs/validate/delegate-validators.md
- docs/docs/validate/validator-concepts.md
- docs/docs/validate/validators-states.md
- docs/docs/ward/demand.md
- docs/docs/ward/incentives.md
- docs/docs/ward/supply.md
- docs/docusaurus.config.ts
- docs/sidebars.ts
- protocol-developer-docs/README.md
- protocol-developer-docs/architecture-decision-records/README.md
- protocol-developer-docs/architecture-decision-records/adr-001.md
- protocol-developer-docs/architecture-decision-records/adr-template.md
- protocol-developer-docs/architecture-decision-records/create-an-adr.md
- protocol-developer-docs/contribute-code.md
- protocol-developer-docs/contribute-docs.md
- protocol-developer-docs/installation.md
- protocol-developer-docs/pull-request-guidelines.md
- protocol-developer-docs/report-issues.md
- protocol-developer-docs/shorthands.md
- protocol-developer-docs/test-metamask-snap.md
Files not reviewed due to errors (7)
- docs/docs/help-center/enable-metamask-snap.md (no review received)
- docs/docs/help-center/introduction.md (no review received)
- docs/docs/help-center/warp-token/warp.md (no review received)
- docs/docs/help-center/buenavista-quick-start.md (no review received)
- docs/docs/learn/warden-protocol-modules/x-warden.md (no review received)
- docs/docs/learn/warden-protocol-modules/x-act.md (no review received)
- docs/docs/build-a-keychain/quick-start.md (no review received)
Files skipped from review due to trivial changes (8)
- docs/.spelling
- docs/docs/build-a-keychain/examples/category.json
- docs/docs/build-a-keychain/keychain-sdk.md
- docs/docs/build-an-oapp/build-the-frontend/category.json
- docs/docs/build-an-oapp/test/category.json
- docs/docs/help-center/use-the-block-explorer.md
- docs/docs/help-center/ward-token/category.json
- docs/docs/learn/warden-protocol-modules/category.json
Additional context used
Path-based instructions (45)
docs/docs/build-a-keychain/examples/clichain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-a-keychain/examples/warden-kms.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/build-the-frontend/quick-start.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/Overview.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/build-the-frontend/wardenjs-functions.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/build-the-frontend/wardenui-components.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/smart-contract-api-reference.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/build-a-custom-smart-contract.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/build-with-wardenjs.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/get-test-ward.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/warden-protocol-modules/introduction.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/quick-start.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/request-a-new-key.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/incentives.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/connect-your-wallet.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/use-dapps.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/create-a-space.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/useful-links.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/ward.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/manage-intents.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/demand.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-a-keychain/introduction.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/introduction.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/airdrop-stages.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/test/run-a-local-chain.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/supply.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/use-walletconnect.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/ward-token/distribution.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/enable-metamask-snap.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/introduction.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/warp-token/warp.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/buenavista-quick-start.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/help-center/warp-token/bridge-base.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/operate-a-node/create-a-validator.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/operate-a-node/delegation-plan.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/request-flow.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/introduction-to-warden.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/warden-protocol-modules/x-warden.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/warden-protocol-modules/x-act.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-a-keychain/quick-start.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/glossary.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/learn/whitepaper.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Markdownlint
docs/docs/build-a-keychain/examples/clichain.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-a-keychain/examples/warden-kms.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-the-frontend/quick-start.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/Overview.md
3-3: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-an-oapp/build-the-frontend/wardenjs-functions.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-the-frontend/wardenui-components.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/smart-contract-api-reference.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-a-custom-smart-contract.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-with-wardenjs.md
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/help-center/get-test-ward.md
13-13: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/learn/warden-protocol-modules/introduction.md
13-13: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/README.md
5-5: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
8-8: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
22-22: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
32-32: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
38-38: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
7-7: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
13-13: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
21-21: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
31-31: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
37-37: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
README.md
13-13: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
6-6: null
Bare URL used(MD034, no-bare-urls)
docs/docs/help-center/request-a-new-key.md
21-21: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/ward-token/incentives.md
15-15: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/connect-your-wallet.md
11-11: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
13-13: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
16-16: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
18-18: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
20-20: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
27-27: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/use-dapps.md
7-7: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
20-20: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/create-a-space.md
23-23: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/ward-token/ward.md
19-19: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
24-24: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
docs/docs/help-center/manage-intents.md
29-29: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/ward-token/demand.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
19-19: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
27-27: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/build-an-oapp/introduction.md
13-13: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/help-center/ward-token/airdrop-stages.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
23-23: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
38-38: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
23-23: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
29-29: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
23-23: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
20-20: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/test/run-a-local-chain.md
30-30: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
55-55: null
Bare URL used(MD034, no-bare-urls)
docs/docs/help-center/ward-token/supply.md
32-32: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
45-45: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
15-15: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
28-28: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
docs/docs/help-center/use-walletconnect.md
31-31: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/ward-token/distribution.md
19-19: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
36-36: null
Files should end with a single newline character(MD047, single-trailing-newline)
27-27: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
28-28: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
29-29: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
30-30: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
31-31: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
32-32: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
docs/docs/help-center/enable-metamask-snap.md
19-19: Expected: 0 or 2; Actual: 3
Trailing spaces(MD009, no-trailing-spaces)
15-15: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
21-21: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
22-22: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
44-44: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/introduction.md
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
48-48: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
50-50: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
52-52: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
55-55: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/help-center/warp-token/warp.md
15-15: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
27-27: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
44-44: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
47-47: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
73-73: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
74-74: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
75-75: Expected: 1; Actual: 4
Multiple consecutive blank lines(MD012, no-multiple-blanks)
22-22: null
Bare URL used(MD034, no-bare-urls)
23-23: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
25-25: null
Bare URL used(MD034, no-bare-urls)
28-28: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/help-center/buenavista-quick-start.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
24-24: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
16-16: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
17-17: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
58-58: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md
63-63: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
106-106: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
10-10: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
17-17: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/docs/help-center/warp-token/bridge-base.md
9-9: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
42-42: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
27-27: null
Bare URL used(MD034, no-bare-urls)
38-38: null
Bare URL used(MD034, no-bare-urls)
40-40: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
58-58: null
Bare URL used(MD034, no-bare-urls)
63-63: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/operate-a-node/create-a-validator.md
15-15: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
21-21: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
66-66: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
70-70: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
92-92: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
99-99: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
106-106: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
114-114: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
33-33: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
100-100: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
17-17: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
23-23: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
29-29: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
43-43: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
49-49: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
61-61: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
67-67: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
73-73: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
93-93: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
119-119: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/docs/operate-a-node/delegation-plan.md
84-84: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
86-86: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
88-88: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
docs/docs/learn/request-flow.md
55-55: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
147-147: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/learn/introduction-to-warden.md
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
90-90: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/learn/warden-protocol-modules/x-warden.md
288-288: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/learn/warden-protocol-modules/x-act.md
276-276: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
115-115: null
Spaces inside link text(MD039, no-space-in-links)
184-184: null
Spaces inside link text(MD039, no-space-in-links)
47-47: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/docs/build-a-keychain/quick-start.md
52-52: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
73-73: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
112-112: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
134-134: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
148-148: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
154-154: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
283-283: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
295-295: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
297-297: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
300-300: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
304-304: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
333-333: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
338-338: Column: 5
Hard tabs(MD010, no-hard-tabs)
412-412: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
119-119: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
76-76: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
118-118: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
271-271: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
118-118: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
docs/docs/learn/glossary.md
294-294: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
310-310: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/learn/whitepaper.md
13-13: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
LanguageTool
docs/docs/learn/warden-protocol-modules/introduction.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...he following modules: -x/act: It executes arbitrary messages ([Actio...(UNLIKELY_OPENING_PUNCTUATION)
README.md
[style] ~8-~8: Consider using an alternative to strengthen your wording.
Context: ...t: https://wardenprotocol.org/. If you want to learn more, join the network or cont...(WANT_KEEN)
[style] ~15-~15: Consider using “except” or “except for”
Context: ...protocol-developer-docs). ## License With the exception of the SpaceWard folder, this project is r...(WITH_THE_EXCEPTION_OF)
docs/docs/help-center/use-dapps.md
[uncategorized] ~19-~19: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...with the Warden Protocol. We anticipate to achieve this goal in the months leading up to t...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
docs/docs/build-an-oapp/useful-links.md
[grammar] ~9-~9: This phrase is duplicated. You should probably use “useful links” only once.
Context: ...nks ## Overview This section contains useful links useful links to docs and resources you can use for b...(PHRASE_REPETITION)
docs/docs/help-center/ward-token/ward.md
[uncategorized] ~26-~26: This expression is usually spelled with a hyphen.
Context: ...a phase of maturity where Warden’s core product market fit has been established and a period o...(PRODUCT_MARKET_HYPHEN)
docs/docs/help-center/manage-intents.md
[uncategorized] ~15-~15: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...art guide](buenavista-quick-start). 2. In the left menu, navigate to Intents....(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
docs/docs/help-center/ward-token/demand.md
[uncategorized] ~21-~21: When a number forms part of an adjectival compound, use a hyphen.
Context: ...locked and can only be unbonded after a 6 month notice period. ## Validator bonds To ...(MISSING_HYPHEN)
docs/docs/build-a-keychain/introduction.md
[uncategorized] ~11-~11: Possible missing preposition found.
Context: ... allows users or external organizations become Keychain operators. They can onboard th...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...-an-oapp/test/run-a-keychain-from-cli). :::(UNLIKELY_OPENING_PUNCTUATION)
docs/docs/build-an-oapp/introduction.md
[grammar] ~14-~14: Consider using the singular form after the singular determiner “This”.
Context: ... front-end interface for Warden. This sections explains how to build the backend and f...(AGREEMENT_SENT_START)
docs/docs/help-center/ward-token/airdrop-stages.md
[typographical] ~23-~23: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...D:docs/docs/ward/airdrop-stages.md - Go to: https://genesis.wardenprotocol.org/ - ...(RP_COLON)
docs/docs/build-an-oapp/test/run-a-local-chain.md
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...e used as alternative starting points. ::: Then run the chain: ```sh wardend s...(UNLIKELY_OPENING_PUNCTUATION)
docs/docs/help-center/use-walletconnect.md
[uncategorized] ~21-~21: Possible missing comma found.
Context: ...art guide](buenavista-quick-start). 4. Cick the WalletConnect logo on the right sid...(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/help-center/ward-token/distribution.md
[typographical] ~9-~9: It appears that a comma is missing.
Context: ...- # Distribution ## Overview In this section you'll find information about the WARD ...(DURING_THAT_TIME_COMMA)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...esis but bonded | Treasury & R&D | 24% |Long term treasury and research programmes | 10M ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...10M available at genesis, linear unlock two year weekly vest | Core contributors | 20% |...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/docs/help-center/enable-metamask-snap.md
[uncategorized] ~12-~12: Possible missing article found.
Context: ...sion is released, you'll be able to use standard orange MetaMask extension. We'll need t...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...ginal MetaMask, pending security audit. ::: ## Prerequisites 👉 [Install MetaM...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ... Remember, this is a developer version. ::: ## Integrate 1. Connect to [SpaceWa...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...eal assets at this stage. Safety first! ::: ## Video tutorial <iframe width="10...(UNLIKELY_OPENING_PUNCTUATION)
docs/docs/help-center/introduction.md
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...vements in the protocol. Stay tuned in! ::: ## Overview 👉 [Try SpaceWard on Bu...(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~17-~17: This word is normally spelled as one.
Context: ...ns. For users: Use the most secure multi-chain multi-sig wallet. Create Spaces, protec...(EN_COMPOUNDS_MULTI_CHAIN)
[style] ~25-~25: The phrase ‘have the ability to’ might be wordy. Consider using “can”.
Context: ...## Main features Within SpaceWard, you have the ability to carry out a wide range of protocol-rela...(HAS_THE_ABILITY_TO)
[duplication] ~34-~34: Possible typo: you repeated a word
Context: ...tion progress and access details in the Explorer 9. Explore the SpaceWard-curated dApp list 10. Exp...(ENGLISH_WORD_REPEAT_RULE)
docs/docs/help-center/buenavista-quick-start.md
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...Otherwise, your might lose your assets. ::: ## Get started The following is a b...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~44-~44: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ou're now all set to explore SpaceWard. Feel free to dive into the platform and share your f...(FEEL_FREE_TO_STYLE_ME)
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md
[uncategorized] ~60-~60: “You” seems less likely than “your” (belonging to you).
Context: ... shulgin --chain-id wardenprotocol ``` You Keychain is ready to be used. ## 2. I...(AI_HYDRA_LEO_CP_YOU_YOUR)
docs/docs/help-center/warp-token/bridge-base.md
[style] ~25-~25: The word ‘big’ tends to be overused. Consider an alternative.
Context: ...very low, so you don't need to bridge a big amount of ETH in USDC value. 1. Go to https:/...(A_GREAT_NUMBER)
[style] ~28-~28: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...o bridge / swap from, and the token you want to use (note: depending on if you use a Co...(REP_WANT_TO_VB)
[style] ~29-~29: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...here select Base) and the token you want to use (here select ETH). ![enter ima...(REP_WANT_TO_VB)
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s://i.ibb.co/HpY6P3L/unnamed-8.png) 5. In TO, click Add address and provi...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~48-~48: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...o bridge / swap from, and the token you want to use (note: depending on if you use a Co...(REP_WANT_TO_VB)
[style] ~49-~49: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...here select Base) and the token you want to use (here select USDC). ![enter im...(REP_WANT_TO_VB)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s://i.ibb.co/4p48qwp/unnamed-6.png) 5. In TO, click Add address and provi...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/docs/operate-a-node/create-a-validator.md
[uncategorized] ~55-~55: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ate a validator Once the node is synced and you have the required WARD, you can bec...(COMMA_COMPOUND_SENTENCE)
[typographical] ~102-~102: After the expression ‘for example’ a comma is usually used.
Context: ...oint change of the commission-rate. For example a change from 1% to 2% is a 100% rate i...(COMMA_FOR_EXAMPLE)
[uncategorized] ~104-~104: Possible missing comma found.
Context: ...flags that can be set to customize your validators you can enter this command: `wardend tx...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~109-~109: Did you mean “too”?
Context: ...files There are certain files you need to backup to be able to restore your valid...(TOO_JJ_TO)
[grammar] ~109-~109: The word “backup” is a noun. The verb is spelled with a space.
Context: ...es There are certain files you need to backup to be able to restore your validator if...(NOUN_VERB_CONFUSION)
docs/docs/operate-a-node/delegation-plan.md
[style] ~79-~79: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ... key factors that delegator may want to take into account when selecting validators: **Self-bond...(EN_WORDINESS_PREMIUM_TAKE_INTO_ACCOUNT)
[grammar] ~89-~89: After the singular determiner ‘Another’, use a singular noun. Did you mean “criterion”?
Context: ... Community contribution: Another criteria is the work validators have contributed...(ANOTHER_NNS)
[uncategorized] ~89-~89: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...in community channels, contributions to open source initiatives etc. Community contribution...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/docs/learn/request-flow.md
[uncategorized] ~59-~59: Possible missing comma found.
Context: ... the public key to the Node. Note: Currently all Keychains available in Warden are M...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~96-~96: A verb may be missing between “I” and “The”, or a word may be misspelled.
Context: ...se details: - Raw data bytes - The key ID - The Approval Rule ID 2. ASignRequestob...(PRP_THE)
[uncategorized] ~121-~121: Possible missing comma found.
Context: ...h the signature to the Node. Note: Currently all Keychains available in Warden are M...(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/learn/introduction-to-warden.md
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...ing soon](/learn/glossary#coming-soon). ::: ## Key protocol features - **Dynami...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~28-~28: Consider removing “of” to be more concise
Context: ...* Ship dApps that can natively access all of the most popular assets, bridges, oracles, ...(ALL_OF_THE)
[style] ~28-~28: ‘in existence’ might be wordy. Consider a shorter alternative.
Context: ...one of the most interoperable protocols in existence with connections to leading blockchains...(EN_WORDINESS_PREMIUM_IN_EXISTENCE)
docs/docs/learn/warden-protocol-modules/x-warden.md
[misspelling] ~23-~23: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...es/x-act#rule): - Admin Rule: It's a applied to all admin operations such as...(EN_A_VS_AN)
[grammar] ~77-~77: The pronoun ‘I’ must be used with a non-third-person form of a verb.
Context: ...ollowing indexes: - Keys by Space ID - Spaces by owner address ## Rules The `x/ward...(NON3PRS_VERB)
docs/docs/learn/warden-protocol-modules/x-act.md
[style] ~37-~37: Consider using “who” when you are referring to people instead of objects.
Context: ... more users. The addresses of the users that approved the Action are stored in its `...(THAT_WHO)
[style] ~43-~43: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...o define Rules, functioning as a very simple smart contract language. Its current ve...(EN_WEAK_ADJECTIVE)
[uncategorized] ~173-~173: Loose punctuation mark.
Context: ...n development and is not available yet. ::: Thex/actmodule re-evaluates the ...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~273-~273: This phrase is duplicated. You should probably use “the Action” only once.
Context: ...tor of the message isn't the creator of the Action. - The Action state isn't pending (`ACTION_STATUS_P...(PHRASE_REPETITION)
docs/docs/build-a-keychain/quick-start.md
[uncategorized] ~9-~9: The preposition ‘to’ seems more likely in this position.
Context: ... a Keychain in Go with the Keychain SDK. ## Prerequis...(AI_HYDRA_LEO_REPLACE_IN_TO)
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...edshulginthat is ready to be used. ::: ### 1.2. Create a Keychain entity Y...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~107-~107: Loose punctuation mark.
Context: ...lic keys on behalf of the Keychain. ::: 3. Note down the mnemonic phrase and...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...R msg="key request handler not set" ``` ::: ## 3. Implement request handlers ##...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~278-~278: Consider a more expressive alternative.
Context: ... and writing them back to the chain. To do this, you need to implement a `KeyReque...(DO_ACHIEVE)
[uncategorized] ~301-~301: Loose punctuation mark.
Context: ...(for example, ECDSA secp256k1) ::: 2. Write a simple in-memory storage:...(UNLIKELY_OPENING_PUNCTUATION)
docs/docs/learn/glossary.md
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...d the key terms related to this update. ::: ### Agent An Agent is an autonomous...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~67-~67: ‘a’ may be redundant when used with the uncountable noun ‘permission’.
Context: ...nnel. --- ## Approval An Approval is a permission for an Action to be performe...(A_UNCOUNTABLE_NOUN)
[uncategorized] ~91-~91: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...general message parsing through Axelar. Currently there are [64 connected chains](https:/...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~242-~242: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ping and bridging but also are able to exchange information with each other. T...(BE_ABLE_TO)
[uncategorized] ~272-~272: Possible missing comma found.
Context: ... in uWARD. --- ## Space A Space is a hub allowing its owner (or multiple owners)...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~313-~313: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...its delegators. The total amount of tokens determines the validator's we...(AMOUNTOF_TO_NUMBEROF)
[style] ~347-~347: Did you mean “that” or “date”?
Context: ...ude the following: - Accessing archive data - Providing services: RPC, GRPC, API, ...(DAT)
[style] ~348-~348: In American English, abbreviations like “etc.” require a period.
Context: ...a - Providing services: RPC, GRPC, API, etc. - Becoming a validator ...(ETC_PERIOD)
docs/docs/learn/whitepaper.md
[style] ~29-~29: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...nerability in the system can compromise any and all applications. Contrary to monolithic en...(EN_WORDINESS_PREMIUM_ANY_AND_ALL)
[uncategorized] ~33-~33: When ‘application-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...p developers to concentrate on creating application specific moats, rather than duplicating tools, r...(SPECIFIC_HYPHEN)
[uncategorized] ~37-~37: A comma might be missing here.
Context: ...etrizable intent configurator. Owing to this OApps can achieve remarkable features: ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~43-~43: A comma might be missing here.
Context: ...chain. They can read and write to other chains which enables a host of completely new ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~43-~43: Consider using a different adverb to strengthen your wording.
Context: ...to other chains which enables a host of completely new use cases enabled by OApps. OApps ...(COMPLETELY_ENTIRELY)
[uncategorized] ~49-~49: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ar-architechture.png) _Figure 1: Warden Protocols modular architecture unbundles the appl...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~50-~50: A comma might be missing here.
Context: ...r greater and more resilient security_ Today digital assets are woefully vulnerable ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~53-~53: When a number forms part of an adjectival compound, use a hyphen.
Context: ...tance, an application on Optimism has a 7 day dispute delay window which cannot be ig...(MISSING_HYPHEN)
[uncategorized] ~53-~53: The preposition ‘in’ seems more likely in this position.
Context: ...rabilities can cascade. A vulnerability on the protocol suddenly doesn’t affect a ...(AI_HYDRA_LEO_REPLACE_ON_IN)
[uncategorized] ~56-~56: You might be missing the article “the” here.
Context: ...e application guarding against misuse. Warden Protocol distinguishes between applicat...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~59-~59: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...d their intent engines. This is critical, because the application layer is closest to use...(COMMA_BEFORE_BECAUSE)
[style] ~65-~65: ‘in control of’ might be wordy. Consider a shorter alternative.
Context: ...lication security setting, putting them in control of defining their own spectrum of custody:...(EN_WORDINESS_PREMIUM_IN_CONTROL_OF)
[typographical] ~69-~69: Usually, there’s no comma before “when”.
Context: ...similar to a time before SQL was created, when querying databases was tricky. In order...(IF_NO_COMMA)
[style] ~69-~69: Consider a shorter alternative to avoid wordiness.
Context: ...ed, when querying databases was tricky. In order to enable arbitrary use cases from several...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~69-~69: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ble, English-like language purpose built so users can configure and preview the tra...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...r set, the oracle ties price updates to consensus where each update requires a ⅔ particip...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: You might be missing the article “the” here.
Context: ...ly when a user’s intents are satisfied. Warden Protocol has an immutable on-chain, int...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~73-~73: Consider a shorter alternative to avoid wordiness.
Context: ...ntent engine that acts as a gatekeeper. In order to prioritize security, minimize attack su...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~97-~97: It looks like there might be a possessive apostrophe missing. Consider inserting it.
Context: ...and creating an abstract syntax tree of users intent_ After generating a key, each O...(AI_EN_LECTOR_MISSING_NOUN_POSSESSIVE)
[style] ~107-~107: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...e’s intent AST at this particular time. Prior to constructing the immutable AST, blockch...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~109-~109: A comma might be missing here.
Context: ...ation. When the final AST is positively evaluatedMsgNewSignRequestis executed. ![Fig...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~119-~119: You might be missing the article “the” here.
Context: ...butor Friendliness A core principle of Warden Protocol is contributor friendliness. C...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~119-~119: You might be missing the article “the” here.
Context: ...come from developers wishing to support Warden Protocol or application developers want...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[misspelling] ~123-~123: This word is normally spelled as one.
Context: ...reate high-performing, provably secure, multi-chain OApps. The platform comes with a robust...(EN_COMPOUNDS_MULTI_CHAIN)
[uncategorized] ~125-~125: Possible missing preposition found.
Context: ...ts to Warden Protocol and seamlessly go omnichain. Thanks to EVM-compatibility, Warden Pr...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~125-~125: You might be missing the article “the” here.
Context: ...omnichain. Thanks to EVM-compatibility, Warden Protocol can support existing Ethereum ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~125-~125: A comma might be missing here.
Context: ...yper, and all the tooling they are used to including familiar environments (e.g. F...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~125-~125: Consider using “who” when you are referring to people instead of objects.
Context: ...eamless experience for those developers that want to transition from Ethereum to War...(THAT_WHO)
Gitleaks
docs/docs/operate-a-node/create-a-validator.md
68-68: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
75-75: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (38)
docs/docs/build-a-keychain/examples/clichain.md (2)
5-7: Placeholder for future contentWhile it's clear that this section is intended for future content, consider providing a brief description or outline of what users can expect. This helps in setting the right expectations and maintaining engagement.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
7-7: Markdown formatting issuesThe emphasis on "Coming soon" should be replaced with a subheading for better document structure and readability.
- *Coming soon* + ## Coming soonAlso, ensure the file ends with a newline to adhere to markdown conventions.
+Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-a-keychain/examples/warden-kms.md (2)
5-7: Placeholder for future contentAs with the previous file, consider providing a brief description or outline of what "WardenKMS" will cover. This could include potential features or the intended audience, which would enhance user anticipation and understanding.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: Markdown formatting issuesReplace the emphasis with a subheading for consistency and improved document structure.
- *Coming soon* + ## Coming soonTools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-the-frontend/quick-start.md (2)
5-7: Placeholder for future contentIt's good to prepare sections for upcoming content, but similarly to previous files, a brief description of what will be covered in this quick start guide would be beneficial. This helps users know what to expect and when they might want to check back.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
7-7: Markdown formatting issuesThe emphasis on "Coming soon" should be a subheading. Additionally, ensure the file ends with a newline.
- *Coming soon* + ## Coming soon +Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/Overview.md (2)
3-3: Updated description of Warden ProtocolThe revised description aligns with the project's new focus. Ensure that this change is reflected consistently across all documentation and promotional materials to avoid confusion.
Tools
Markdownlint
3-3: null
Files should end with a single newline character(MD047, single-trailing-newline)
3-3: Markdown formatting issuesEnsure the file ends with a newline to adhere to markdown conventions.
+Tools
Markdownlint
3-3: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-an-oapp/build-the-frontend/wardenjs-functions.md (2)
5-14: Placeholder and future content annotationsThe use of placeholders is consistent with other documentation files. However, consider adding more context or expected timelines for the content to be added. The commented-out list seems to be a draft for future content; ensure it's completed in a timely manner to maintain documentation integrity.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
7-7: Markdown formatting issuesReplace the emphasis with a subheading. This change will enhance the document's structure and readability.
- *Coming soon* + ## Coming soonTools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/help-center/warp-token/_category_.json (1)
2-8: Configuration looks correct and well-defined.The JSON structure is valid and the properties such as
position,label,collapsible, andlinkwithtitleare appropriately set.docs/docs/build-an-oapp/build-the-frontend/wardenui-components.md (1)
1-13: Documentation structure approved.The rest of the document structure, including the sidebar position and the comment about future content, is well-organized.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/smart-contract-api-reference.md (1)
1-13: Structure of the document approved.The sidebar position and the placeholder comments about future decisions on content are clear and well-placed.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-a-custom-smart-contract.md (1)
1-13: Document structure approved.The sidebar position and the placeholder for future content are appropriately set.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/build-with-wardenjs.md (1)
1-16: Overall structure and content planning approved.The sidebar position, planned content, and notes are well-organized and clear.
Tools
Markdownlint
7-7: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/introduction.md (1)
13-13: Remove excessive blank lines.There are two consecutive blank lines, which is unnecessary and can be reduced to a single blank line to maintain cleanliness.
-Tools
Markdownlint
13-13: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/help-center/ward-token/airdrop-stages.md (2)
Line range hint
37-38: Remove excessive blank lines.There are multiple consecutive blank lines that should be reduced to improve the document's cleanliness.
- -Tools
LanguageTool
[typographical] ~23-~23: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...D:docs/docs/ward/airdrop-stages.md - Go to: https://genesis.wardenprotocol.org/ - ...(RP_COLON)
Markdownlint
23-23: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
23-23: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
29-29: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
23-23: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
20-20: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Line range hint
9-9: Remove trailing spaces.There are trailing spaces that should be removed to adhere to best Markdown practices.
- The first snapshot for a portion of the airdrop of $WARD has been completed. This is merely the initial step among various potential methods to gain access to the $WARD Airdrop. + The first snapshot for a portion of the airdrop of $WARD has been completed. This is merely the initial step among various potential methods to gain access to the $WARD Airdrop.docs/docs/build-an-oapp/test/run-a-local-chain.md (1)
30-30: Remove excessive blank lines.There are multiple consecutive blank lines that should be reduced to improve the document's cleanliness.
-Tools
Markdownlint
30-30: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
docs/docs/help-center/ward-token/supply.md (3)
15-15: Remove excessive blank lines.There are multiple consecutive blank lines that should be reduced to improve the document's cleanliness.
-Tools
Markdownlint
15-15: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
28-28: Add blank lines around headings.Headings should be surrounded by blank lines to adhere to best Markdown practices.
+ +Tools
Markdownlint
28-28: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
32-32: Remove trailing spaces.There are trailing spaces that should be removed to adhere to best Markdown practices.
- - **Below Target Staking:** If the percentage of staked WARD is less than the target of 65%, the issuance rate will incrementally increase. This adjustment continues until it reaches the maximum rate of 10% or until the staking target is met. + - **Below Target Staking:** If the percentage of staked WARD is less than the target of 65%, the issuance rate will incrementally increase. This adjustment continues until it reaches the maximum rate of 10% or until the staking target is met. - - **At Target Staking:** When the staking ratio aligns with the 65% target, the current issuance rate remains unchanged. + - **At Target Staking:** When the staking ratio aligns with the 65% target, the current issuance rate remains unchanged.Also applies to: 34-34
Tools
Markdownlint
32-32: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
docs/docs/help-center/use-walletconnect.md (1)
37-37: Add a newline at the end of the file.Files should end with a single newline character to adhere to best Markdown practices.
+Tools
Markdownlint
37-37: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (5)
18-20: Update entity names to maintain consistency.The renaming of
KEYCHAIN_PARTY_NAMEtoKEYCHAIN_WRITER_NAMEandKEYCHAIN_PARTYtoKEYCHAIN_WRITERaligns with the PR's goal of consistent terminology across the documentation.
43-46: Correct command to add new key and retrieve it.This change updates the command to reflect the new entity name
KEYCHAIN_WRITER_NAMEand ensures the command syntax is correct for adding and retrieving keys.
58-58: Ensure correct command usage for adding a keychain writer.The command has been updated to use the new entity
KEYCHAIN_WRITER, which is consistent with other changes in the document.
101-101: Update command to use new entity names correctly.The command has been updated to use
KEYCHAIN_WRITER_NAMEinstead ofKEYCHAIN_PARTY_NAME, aligning with the renaming strategy in the PR.
138-138: Correct command syntax for fulfilling a signature request.This change updates the command to use the correct variable
SIGNATURE_REQUEST_IDinstead ofSIGN_REQUEST_ID, ensuring consistency in variable usage.docs/docs/help-center/warp-token/bridge-base.md (1)
33-33: Avoid repetitive phrasing in instructions.The repeated phrase "click Add address and provide a destination address" could be varied to improve readability.
- click **Add address** and provide a destination address + click **Add address** and enter a destination addressAlso applies to: 53-53
Tools
LanguageTool
[style] ~33-~33: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...s://i.ibb.co/HpY6P3L/unnamed-8.png) 5. In TO, click Add address and provi...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/docs/operate-a-node/create-a-validator.md (1)
68-68: Sensitive information in documentation.The documentation contains a generic API key example that should be clearly marked as an example to avoid misuse.
- {"@type":"/cosmos.crypto.ed25519.PubKey","key":"lR1d7YBVK5jYijOfWVKRFoWCsS4dg3kagT7LB9GnG8I="} + {"@type":"/cosmos.crypto.ed25519.PubKey","key":"EXAMPLE_KEY_HERE"}Also applies to: 75-75
Tools
Gitleaks
68-68: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
docs/docs/learn/request-flow.md (1)
65-85: Diagram syntax and formatting check.Ensure the mermaid diagram syntax is correct and renders properly in the intended markdown viewers.
docs/docs/learn/introduction-to-warden.md (3)
7-13: Introduction Section Looks GoodThe introductory paragraph effectively sets the stage for understanding the Warden Protocol's capabilities and its ecosystem.
75-90: Documentation Overview Section is ClearThe overview is well-structured, providing users with clear navigation paths within the documentation.
Tools
Markdownlint
90-90: null
Files should end with a single newline character(MD047, single-trailing-newline)
88-90: Clear Call to Action for ContributorsThe section effectively directs potential contributors to the necessary resources.
Tools
Markdownlint
90-90: null
Files should end with a single newline character(MD047, single-trailing-newline)
docs/docs/learn/glossary.md (1)
347-348: Clarify the abbreviation and fix punctuation.Ensure that abbreviations are followed by a period in American English, and clarify the abbreviation "data."
- Accessing archive data - Providing services: RPC, GRPC, API, etc. + Accessing archive data - Providing services: RPC, GRPC, API, etc.Likely invalid or redundant comment.
Tools
LanguageTool
[style] ~347-~347: Did you mean “that” or “date”?
Context: ...ude the following: - Accessing archive data - Providing services: RPC, GRPC, API, ...(DAT)
[style] ~348-~348: In American English, abbreviations like “etc.” require a period.
Context: ...a - Providing services: RPC, GRPC, API, etc. - Becoming a validator ...(ETC_PERIOD)
docs/docs/learn/whitepaper.md (3)
9-11: Good use of warning note.The warning about ongoing updates is clear and well-placed. It helps set the right expectations for the readers.
Line range hint
15-18: Comprehensive explanation of the modular architecture.The section clearly outlines the benefits of a modular blockchain infrastructure, emphasizing security and interoperability.
Tools
Markdownlint
13-13: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
7-7: Verify the updated PDF link.Please ensure that the updated link to the PDF version of the whitepaper is correct and accessible.
Verification successful
Verified the updated PDF link.
The updated link to the PDF version of the whitepaper is correct and accessible.
- Line 7: Download the PDF version
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the PDF link is accessible. curl -o /dev/null -s -w "%{http_code}\n" https://docs.wardenprotocol.org/The_Warden_Protocol_Whitepaper.pdfLength of output: 113
|
|
||
| ## Validator | ||
|
|
||
| A validator is an individual or entity that participates in the [staking](#staking) process by running a [full](#full-node) or pruned [Warden Protocol node](#warden-protocol-node) and validating blocks and transactions. |
There was a problem hiding this comment.
Fix formatting issues.
Address trailing spaces and multiple consecutive blank lines to adhere to Markdown best practices.
- A validator is an individual or entity that participates in the [staking](#staking) process by running a [full](#full-node) or pruned [Warden Protocol node](#warden-protocol-node) and validating blocks and transactions.
+ A validator is an individual or entity that participates in the [staking](#staking) process by running a [full](#full-node) or pruned [Warden Protocol node](#warden-protocol-node) and validating blocks and transactions.
- Also applies to: 310-310
Tools
Markdownlint
294-294: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
|
|
||
| ## Space | ||
|
|
||
| A Space is a hub allowing its owner (or multiple owners) to manage [keys](#key). Spaces contribute to Warden's [Chain Abstraction](#chain-abstraction): they aggregate accounts for different blockchains and provide access to [Omnichain Applications](#omnichain-application). |
There was a problem hiding this comment.
Add a comma for clarity.
A comma after "owner" might improve the clarity of the sentence.
- A Space is a hub allowing its owner (or multiple owners) to manage [keys](#key).
+ A Space is a hub allowing its owner, (or multiple owners) to manage [keys](#key).Committable suggestion was skipped due to low confidence.
Tools
LanguageTool
[uncategorized] ~272-~272: Possible missing comma found.
Context: ... in uWARD. --- ## Space A Space is a hub allowing its owner (or multiple owners)...(AI_HYDRA_LEO_MISSING_COMMA)
| :::tip | ||
| We're currently implementing a breaking update to the Warden Protocol. [Omnichain Application](#omnichain-application) developers will be able to build and integrate AI-driven [Agents](#agent) – autonomous trainable programs independently managing complex processes. Below you'll find the key terms related to this update. | ||
| ::: |
There was a problem hiding this comment.
Consider adjusting the punctuation.
The punctuation mark after "update" might be misplaced or unnecessary.
- We're currently implementing a breaking update to the Warden Protocol. [Omnichain Application](#omnichain-application) developers will be able to build and integrate AI-driven [Agents](#agent) – autonomous trainable programs independently managing complex processes. Below you'll find the key terms related to this update.
+ We're currently implementing a breaking update to the Warden Protocol. [Omnichain Application](#omnichain-application) developers will be able to build and integrate AI-driven [Agents](#agent) – autonomous trainable programs independently managing complex processes. Below you'll find the key terms related to this update: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.
| :::tip | |
| We're currently implementing a breaking update to the Warden Protocol. [Omnichain Application](#omnichain-application) developers will be able to build and integrate AI-driven [Agents](#agent) – autonomous trainable programs independently managing complex processes. Below you'll find the key terms related to this update. | |
| ::: | |
| :::tip | |
| We're currently implementing a breaking update to the Warden Protocol. [Omnichain Application](#omnichain-application) developers will be able to build and integrate AI-driven [Agents](#agent) – autonomous trainable programs independently managing complex processes. Below you'll find the key terms related to this update: | |
| ::: |
Tools
LanguageTool
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...d the key terms related to this update. ::: ### Agent An Agent is an autonomous...(UNLIKELY_OPENING_PUNCTUATION)
|
|
||
| Omnichain Interoperability is one of Warden's key features. It refers to the possibility of communication between different blockchain networks. | ||
|
|
||
| While most interoperability providers focus on particular ecosystems, Warden's goal is connecting different ecosystems. [Omnichain Applications](#omnichain-application) not only provide cross-chain swapping and [bridging](#bridging) but also are able to exchange information with each other. This allows overcoming the fragmentation of the blockchain landscape. |
There was a problem hiding this comment.
Simplify the expression.
Consider using "can" instead of "are able to" for conciseness.
- [bridging](#bridging) but also are able to exchange information with each other.
+ [bridging](#bridging) but also can exchange information with each other.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.
| While most interoperability providers focus on particular ecosystems, Warden's goal is connecting different ecosystems. [Omnichain Applications](#omnichain-application) not only provide cross-chain swapping and [bridging](#bridging) but also are able to exchange information with each other. This allows overcoming the fragmentation of the blockchain landscape. | |
| While most interoperability providers focus on particular ecosystems, Warden's goal is connecting different ecosystems. [Omnichain Applications](#omnichain-application) not only provide cross-chain swapping and [bridging](#bridging) but also can exchange information with each other. This allows overcoming the fragmentation of the blockchain landscape. |
Tools
LanguageTool
[style] ~242-~242: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ping and bridging but also are able to exchange information with each other. T...(BE_ABLE_TO)
|
|
||
| ## Validator's weight | ||
|
|
||
| Each [validator](#validator) has its own [WARD tokens](#ward-token) and tokens bonded by its [delegators](#delegator). The total amount of tokens determines the validator's weight. |
There was a problem hiding this comment.
Consider using "number" instead of "amount."
The word "amount" is typically used with uncountable nouns, whereas "number" is used with countable nouns like "tokens."
- The total amount of tokens determines the validator's weight.
+ The total number of tokens determines the validator's weight.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.
| Each [validator](#validator) has its own [WARD tokens](#ward-token) and tokens bonded by its [delegators](#delegator). The total amount of tokens determines the validator's weight. | |
| Each [validator](#validator) has its own [WARD tokens](#ward-token) and tokens bonded by its [delegators](#delegator). The total number of tokens determines the validator's weight. |
Tools
LanguageTool
[uncategorized] ~313-~313: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...its delegators. The total amount of tokens determines the validator's we...(AMOUNTOF_TO_NUMBEROF)
|
|
||
| # Use dApps | ||
|
|
||
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. |
There was a problem hiding this comment.
Remove trailing spaces.
Trailing spaces detected. These should be removed to comply with Markdownlint standards.
- Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience.
+ Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience.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.
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. | |
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. |
Tools
Markdownlint
7-7: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
|  | ||
|
|
||
| :::note | ||
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate to achieve this goal in the months leading up to the mainnet launch. |
There was a problem hiding this comment.
Consider revising the verb form for clarity.
The phrase "We anticipate to achieve" may be grammatically incorrect. Consider revising to "We anticipate achieving."
- We anticipate to achieve this goal in the months leading up to the mainnet launch.
+ We anticipate achieving this goal in the months leading up to the mainnet launch.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.
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate to achieve this goal in the months leading up to the mainnet launch. | |
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate achieving this goal in the months leading up to the mainnet launch. |
Tools
LanguageTool
[uncategorized] ~19-~19: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...with the Warden Protocol. We anticipate to achieve this goal in the months leading up to t...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
| --- | ||
| sidebar_position: 7 | ||
| --- | ||
|
|
||
| # Use dApps | ||
|
|
||
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. | ||
|
|
||
| You can connect to any EVM dApp through WalletConnect: 👉 [Use WalletConnect](use-walletconnect) | ||
|
|
||
| Alternatively, access a **SpaceWard-curated collection** of dApps: | ||
|
|
||
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | ||
| 2. In the left menu, navigate to **Apps**. | ||
|
|
||
|  | ||
|
|
||
| :::note | ||
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate to achieve this goal in the months leading up to the mainnet launch. | ||
| ::: |
There was a problem hiding this comment.
Ensure the file ends with a newline character.
The markdown file should end with a single newline character to meet Markdownlint standards.
+ 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.
| --- | |
| sidebar_position: 7 | |
| --- | |
| # Use dApps | |
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. | |
| You can connect to any EVM dApp through WalletConnect: 👉 [Use WalletConnect](use-walletconnect) | |
| Alternatively, access a **SpaceWard-curated collection** of dApps: | |
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | |
| 2. In the left menu, navigate to **Apps**. | |
|  | |
| :::note | |
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate to achieve this goal in the months leading up to the mainnet launch. | |
| ::: | |
| --- | |
| sidebar_position: 7 | |
| --- | |
| # Use dApps | |
| Within SpaceWard, you can access **decentralized applications** (**dApps**) across various blockchains. These applications streamline and centralize your decentralized finance activities for simplicity and convenience. | |
| You can connect to any EVM dApp through WalletConnect: 👉 [Use WalletConnect](use-walletconnect) | |
| Alternatively, access a **SpaceWard-curated collection** of dApps: | |
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | |
| 2. In the left menu, navigate to **Apps**. | |
|  | |
| :::note | |
| As the testnet phase advances, we plan to enhance connectivity with Cosmos chains. Cosmos wallets will gain the ability to interact directly once they are fully integrated with the Warden Protocol. We anticipate to achieve this goal in the months leading up to the mainnet launch. | |
| ::: | |
Tools
LanguageTool
[uncategorized] ~19-~19: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...with the Warden Protocol. We anticipate to achieve this goal in the months leading up to t...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
Markdownlint
7-7: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
20-20: null
Files should end with a single newline character(MD047, single-trailing-newline)
| --- | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| # Create a Space | ||
|
|
||
| A **Space** functions as a management hub for a collection of keys, akin to an organization. | ||
|
|
||
| You can maintain separate Spaces for distinct purposes, such as distinguishing between personal and professional uses. | ||
|
|
||
| When you first [connect your wallet](connect-your-wallet) to SpaceWard, a Space is created automatically. To create additional Spaces, do the following: | ||
|
|
||
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | ||
|
|
||
| 2. In the top-left corner of the page, Click **Active Space**. | ||
|
|
||
|  | ||
|
|
||
| 3. Click **Create New Space**. This will make your Cosmos wallet execute a transaction that creates a new Space. | ||
|
|
||
|  | ||
|
|
||
| 4. After the blockchain confirms the transaction, your new Space will be available for use. |
There was a problem hiding this comment.
Ensure the file ends with a newline character.
The markdown file should end with a single newline character to meet Markdownlint standards.
+ 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.
| --- | |
| sidebar_position: 5 | |
| --- | |
| # Create a Space | |
| A **Space** functions as a management hub for a collection of keys, akin to an organization. | |
| You can maintain separate Spaces for distinct purposes, such as distinguishing between personal and professional uses. | |
| When you first [connect your wallet](connect-your-wallet) to SpaceWard, a Space is created automatically. To create additional Spaces, do the following: | |
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | |
| 2. In the top-left corner of the page, Click **Active Space**. | |
|  | |
| 3. Click **Create New Space**. This will make your Cosmos wallet execute a transaction that creates a new Space. | |
|  | |
| 4. After the blockchain confirms the transaction, your new Space will be available for use. | |
| --- | |
| sidebar_position: 5 | |
| --- | |
| # Create a Space | |
| A **Space** functions as a management hub for a collection of keys, akin to an organization. | |
| You can maintain separate Spaces for distinct purposes, such as distinguishing between personal and professional uses. | |
| When you first [connect your wallet](connect-your-wallet) to SpaceWard, a Space is created automatically. To create additional Spaces, do the following: | |
| 1. Connect to [SpaceWard](https://spaceward.buenavista.wardenprotocol.org). If it's your first time, see the [Quick start guide](buenavista-quick-start). | |
| 2. In the top-left corner of the page, Click **Active Space**. | |
|  | |
| 3. Click **Create New Space**. This will make your Cosmos wallet execute a transaction that creates a new Space. | |
|  | |
| 4. After the blockchain confirms the transaction, your new Space will be available for use. | |
Tools
Markdownlint
23-23: null
Files should end with a single newline character(MD047, single-trailing-newline)
| ## Key protocol features | ||
|
|
||
| - **Dynamic smart contracts** | ||
| Utilize a next-generation CosmWasm smart contract layer capable of autonomous logic execution to ship truly decentralized applications with a flexible development suite powered by Rust. | ||
|
|
||
| - **Novel Web3 modules** | ||
| Access the premier plug-and-play Web3 modules to rapidly iterate a diverse array of groundbreaking dApps. | ||
|
|
||
| - **Unprecedented interoperability** | ||
| Ship dApps that can natively access all of the most popular assets, bridges, oracles, and wallets. Warden is one of the most interoperable protocols in existence with connections to leading blockchains such as Ethereum and Cosmos while also being IBC-enabled. | ||
|
|
||
| - **Highly secure** | ||
| Deploy on a Tendermint-based PoS network secured by a globally distributed group of renowned validators and trusted by leading institutions worldwide. | ||
|
|
There was a problem hiding this comment.
Consider a More Concise Expression
The phrase "in existence" might be wordy. Consider a shorter alternative to enhance readability.
- Warden is one of the most interoperable protocols in existence with connections to leading blockchains such as Ethereum and Cosmos while also being IBC-enabled.
+ Warden is among the most interoperable protocols, connecting to leading blockchains like Ethereum and Cosmos, and supports IBC.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.
| ## Key protocol features | |
| - **Dynamic smart contracts** | |
| Utilize a next-generation CosmWasm smart contract layer capable of autonomous logic execution to ship truly decentralized applications with a flexible development suite powered by Rust. | |
| - **Novel Web3 modules** | |
| Access the premier plug-and-play Web3 modules to rapidly iterate a diverse array of groundbreaking dApps. | |
| - **Unprecedented interoperability** | |
| Ship dApps that can natively access all of the most popular assets, bridges, oracles, and wallets. Warden is one of the most interoperable protocols in existence with connections to leading blockchains such as Ethereum and Cosmos while also being IBC-enabled. | |
| - **Highly secure** | |
| Deploy on a Tendermint-based PoS network secured by a globally distributed group of renowned validators and trusted by leading institutions worldwide. | |
| - **Unprecedented interoperability** | |
| Ship dApps that can natively access all of the most popular assets, bridges, oracles, and wallets. Warden is among the most interoperable protocols, connecting to leading blockchains like Ethereum and Cosmos, and supports IBC. |
Tools
LanguageTool
[style] ~28-~28: Consider removing “of” to be more concise
Context: ...* Ship dApps that can natively access all of the most popular assets, bridges, oracles, ...(ALL_OF_THE)
[style] ~28-~28: ‘in existence’ might be wordy. Consider a shorter alternative.
Context: ...one of the most interoperable protocols in existence with connections to leading blockchains...(EN_WORDINESS_PREMIUM_IN_EXISTENCE)
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (5 hunks)
- docs/docs/help-center/ward-token/airdrop-stages.md (1 hunks)
Additional context used
Path-based instructions (2)
docs/docs/help-center/ward-token/airdrop-stages.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Markdownlint
docs/docs/help-center/ward-token/airdrop-stages.md
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
20-20: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
26-26: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md
18-18: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
LanguageTool
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md
[grammar] ~61-~61: Possible error detected: Please verify that having a noun follow a pronoun is correct in this context.
Context: ... shulgin --chain-id wardenprotocol ``` You Keychain is ready to be used. ## 2. Install `cl...(PRONOUN_NOUN)
Additional comments not posted (5)
docs/docs/help-center/ward-token/airdrop-stages.md (2)
2-2: Update the sidebar position.This change likely corresponds to the reordering of the documentation structure to prioritize the visibility of airdrop stages.
22-22: Correct and improve link formatting for clarity and accessibility.The links should be formatted consistently to improve readability and accessibility.
This is a duplicate of a past review comment but still valid.
Also applies to: 24-24
docs/docs/build-an-oapp/test/run-a-keychain-from-cli.md (3)
2-2: Update the sidebar position.This change likely corresponds to the reordering of the documentation structure to prioritize the visibility of this guide.
20-21: Ensure accurate and consistent use of terminology in command examples.The changes from "party" to "writer" align with the updated terminology in the Warden protocol, improving clarity and reducing confusion.
Also applies to: 44-45, 47-47, 101-101, 134-134
61-61: Correct typographical error in the text.This is a duplicate of a past review comment but still valid.
Tools
LanguageTool
[grammar] ~61-~61: Possible error detected: Please verify that having a noun follow a pronoun is correct in this context.
Context: ... shulgin --chain-id wardenprotocol ``` You Keychain is ready to be used. ## 2. Install `cl...(PRONOUN_NOUN)
|
|
||
| ### Snapshot 1 - OPEN token holders OG Snapshot | ||
|
|
||
| **TL;DR** |
There was a problem hiding this comment.
Convert emphasized text to headings for better structure.
Using emphasis instead of headings can lead to poor document structure and readability issues.
- **TL;DR**
+ ### TL;DR
- **Check your airdrop**
+ ### Check your airdrop
- **Notes**
+ ### NotesAlso applies to: 20-20, 26-26
Tools
Markdownlint
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
|
|
||
| ## 1. Create a new Keychain | ||
| ## 1. Create a Keychain | ||
|
|
||
| If running locally, you can skip this step and assume an initial Keychain was set up at genesis: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Specify language for code blocks.
- ```
+ ```bashSpecifying the language for code blocks improves readability and syntax highlighting in Markdown viewers.
Also applies to: 18-18
Tools
Markdownlint
18-18: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Summary by CodeRabbit
Documentation
New Features