Skip to content

docs: restructure README and promote docs website - #284

Merged
zheli merged 1 commit into
mainfrom
zzz/a155ad9f
Jul 27, 2026
Merged

docs: restructure README and promote docs website#284
zheli merged 1 commit into
mainfrom
zzz/a155ad9f

Conversation

@zheli

@zheli zheli commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Restructure the root README like popular tool repos: Docs badge, website link, short pitch, quick start, features, thin install, docs pointer
  • Promote https://bitdynamics-ab.github.io/canton-devkit/ as the project main website
  • Rename website/README.md to website/DEVELOPMENT.md (Astro maintainer how-to); leave the Starlight index as the richer landing page

Test plan

  • Preview README on GitHub: Docs badge and Website link open the published site
  • Confirm install/prereq numbers match getting-started (~8 GB RAM / ~20 GB disk)
  • Confirm website/DEVELOPMENT.md renders and no broken links to website/README.md

Keep the root README short (quick start, features, thin install) and
point users at https://bitdynamics-ab.github.io/canton-devkit/ as the
main website; rename website/README.md to DEVELOPMENT.md for Astro
maintainer notes.
@cursor

cursor Bot commented Jul 27, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@zheli
zheli merged commit 8f082cb into main Jul 27, 2026
@zheli
zheli deleted the zzz/a155ad9f branch July 27, 2026 19:17
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