Skip to content

docs: HackCanton Season 3 starter for canton-devkit (BIT-315) - #341

Merged
zheli merged 4 commits into
mainfrom
cursor/hackcanton-s3-starter-2ff7
Sep 15, 2026
Merged

zheli merged 4 commits into
mainfrom
cursor/hackcanton-s3-starter-2ff7

Conversation

@zheli

@zheli zheli commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a beginner-facing HackCanton Season 3 starter page for Noders (Ales) — install, one working LocalNet example, and things that commonly break — so it can ship in the Season 3 starter pack (due 15 Sep 2026).

This is BIT-315. Commands are copied from the current CLI / getting-started / troubleshooting docs; no new flags or flows.

Changes

Test plan

  • Commands in the new page checked against the live Cobra surface (up/status/env positional name, token demo --instance, token transfer --auto-accept, dar upload --instance, ui, doctor, creds --format raw, remove)
  • cd website && npm test (11/11 docs sync unit tests)
  • cd website && npm run build — route /hackcanton-s3/ generated; sidebar slug hackcanton-s3; sibling .md links rewritten to site URLs
  • Previewed locally: title, install → example → common breaks, homepage callout, Getting Started nav

Checklist

  • Tests pass locally (website unit tests + docs build)
  • No coverage regression on touched code (docs-only)
  • Docs updated (and website/ synced if any mirrored docs/*.md changed)
  • CLI ↔ Web UI parity maintained (docs-only; no CLI/UI change)

Deep link for Ales (after merge + Pages deploy)

https://bitdynamics-ab.github.io/canton-devkit/hackcanton-s3/

Open in Web Open in Cursor 

@zheli
zheli marked this pull request as ready for review September 14, 2026 16:27
@zheli
zheli force-pushed the cursor/hackcanton-s3-starter-2ff7 branch from 8d22340 to 79c5960 Compare September 15, 2026 07:14
Day-one page for Noders starter pack: install, one working LocalNet
example (token demo), and common breaks, wired into the docs site nav,
README, and getting-started.
Refine the documentation to clarify the use of canton-devkit for running Daml applications in a LocalNet environment. Added a Telegram support channel link and streamlined installation requirements for Docker and Docker Compose.
Refine the documentation for using canton-devkit in a LocalNet environment. Improved clarity on installation steps, command usage, and troubleshooting tips. Updated language for better readability and consistency.
…oting

Refine the documentation by renaming the "Things that commonly break" section to "Troubleshooting" for better clarity. Removed an unnecessary command and ensured consistency in command formatting. This enhances the user experience for those utilizing canton-devkit in a LocalNet environment.
@zheli
zheli force-pushed the cursor/hackcanton-s3-starter-2ff7 branch from 79c5960 to e153ef6 Compare September 15, 2026 07:16
@zheli
zheli merged commit fd215c0 into main Sep 15, 2026
@zheli
zheli deleted the cursor/hackcanton-s3-starter-2ff7 branch September 15, 2026 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant