WIP #2
WIP #2
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
- Update Mermaid theme to use black/green colors (#000000, #00ff00) - Convert all ASCII box diagrams to Mermaid with proper colors: - Four-layer architecture diagram - Node architecture diagram - All core concept diagrams updated with black/green theme - Ensure all diagrams have high contrast and visibility - Directory trees kept as ASCII (appropriate for file structures)
- Split complex sync flow diagram into two simpler diagrams - Split transaction flow into simple and detailed views - Make architecture page more concise with README references - Simplify applications, identity, contexts, and nodes pages - Clean up placeholder content in Operator Track and Reference - Fix broken anchor links - Add component relationship diagram to architecture page
- Consolidate getting-started into single comprehensive guide - Remove all stub pages with TODOs (reference, examples, operator-track) - Fix graph sizes - simplify complex diagrams - Fix graph colors - use proper black/green theme - Update navigation structure - Fix broken links
- Convert sequenceDiagram to flowchart (sequence diagrams don't support styles) - Simplify node labels (remove long text) - Change 'graph TB' to 'flowchart TD/LR' (modern syntax) - Remove nested subgraphs where possible - Shorten all labels for better readability - Fix syntax errors in all diagrams
…ility - Change all nodes to dark fills (#1a1a1a) with green borders (#00ff00) - Set white text color for all nodes - Match the working style from Periodic P2P Sync graph - Ensure all graphs are visible on dark backgrounds
- Fix WASM Execution Flow graph (applications.md) - Fix all graphs in contexts.md, identity.md, index.md, nodes.md - Fix graphs in js-sdk-guide.md - Use consistent style: dark fills (#1a1a1a) with green borders (#00ff00) - Set white text color for all nodes - Ensure all graphs are visible on dark backgrounds
- Merge Tools & APIs into Operate section - Rename Quick Start to Getting Started - Consolidate operational tools (nodes, monitoring, CLI, client SDKs, dev tools) under Operate - Reduce top-level tabs from 7 to 6 - Remove redundant Tools section
- Convert stateDiagram to flowchart (state diagrams don't support inline styles) - Update Mermaid theme to dark with white text by default - Ensure all graphs use white text (#ffffff) for visibility - Fix black text on black background issue
- Consolidate Build, Operate, and Reference tabs into one 'Guides' section - Organize Guides into sub-sections: Building Applications, Running Nodes, Tools, API Reference - Reduce top-level tabs from 6 to 4 (Home, Getting Started, Concepts, Guides) - Remove Homebrew Tap, MPC Signer, Escrow from tools-apis - Remove Getting Help section from getting-started - Convert all vertical graphs (TD/TB) to horizontal (LR) for better readability
There was a problem hiding this comment.
Bug: Tool Name Typo Breaks Command Example
Incorrect tool name calimero-abi-generator is used in the command example instead of the correct calimero-abi-codegen. The command will fail because the tool doesn't exist with that name.
docs/builder-directory/index.md#L551-L552
docs/docs/builder-directory/index.md
Lines 551 to 552 in 62d93fe
Bug: Broken Script: Wrong Tool Name
Incorrect tool name calimero-abi-generator is used in the package.json script instead of the correct calimero-abi-codegen. This script will fail when executed.
docs/builder-directory/index.md#L846-L847
docs/docs/builder-directory/index.md
Lines 846 to 847 in 62d93fe
| Don't worry about installing these individually - the setup process will handle it. | ||
|
|
||
| ## Two Paths to Get Started | ||
| ## Choose Your Starting Point |
There was a problem hiding this comment.
Bug: Fix tool naming inconsistency for clarity.
Incorrect tool name calimero-abi-generator is used instead of the correct calimero-abi-codegen. The actual tool is @calimero-network/abi-codegen as documented in the developer tools guide, and commands should use npx calimero-abi-codegen. This will cause confusion and failed commands when users try to follow the documentation.
- Add intro/index.md to navigation menu - Fix malformed code block in applications.md (remove extra closing fence) - Fix tool naming: calimero-abi-generator -> @calimero-network/abi-codegen - Fix meroctl flag: --node-name -> --node throughout docs - Fix all command examples to use correct flags - Update package.json script examples with correct tool names
|
|
||
| **5. Install on node:** | ||
| ```bash | ||
| meroctl --node-name node1 app install \ |
There was a problem hiding this comment.
Bug: meroctl Command Flag Error
The meroctl command uses the incorrect flag --node-name instead of --node. According to the meroctl CLI documentation, the correct flag for specifying a node is --node, not --node-name. This will cause the command to fail with an unrecognized flag error.
| ```bash | ||
| cd core/apps/kv-store | ||
| ./build.sh | ||
| meroctl --node-name node1 app install --path build/kv_store.wasm |
There was a problem hiding this comment.
Bug: meroctl Uses Unrecognized Node Flag
The meroctl command uses the incorrect flag --node-name instead of --node. According to the meroctl CLI documentation, the correct flag for specifying a node is --node, not --node-name. This will cause the command to fail with an unrecognized flag error.
Note
Overhauls the docs site with comprehensive core concepts, getting started, builder/operator guides, tools & SDK references, examples, and updates site theming, navigation, and Mermaid support.
core-concepts/*(architecture, applications, contexts, identity, nodes).getting-started,builder-directory(Rust SDK, JS SDK),operator-track(run, monitor),tools-apis(CLI, client SDKs, developer tools),reference.examples/*andapp-directory(featured projects), homepage rewrite, and support section stubs.@calimero-network/abi-codegen.mkdocs.ymlwith full navigation, tabs, TOC, Mermaid plugin, custom palettes/fonts.stylesheets/extra.css) for light/dark themes and layout; add JS (javascripts/sidebar.js) to hide sparse sidebars.requirements.txtto includemkdocs-mermaid2-plugin.Written by Cursor Bugbot for commit 251ac32. This will update automatically on new commits. Configure here.