docs icon indicating copy to clipboard operation
docs copied to clipboard

feat: clarity documentation

Open ryanwaits opened this issue 1 year ago • 3 comments

What does this PR do?

This PR introduces a new initiative in our documentation that emphasizes the why and when behind using specific Clarity functions, alongside real-world blockchain use cases.

Each section explains relevant use cases, discusses the significance of the functions, and includes code samples to illustrate their implementation, along with best practices and common patterns.

  • [x] Each function documents
  • [x] A few additional guides for basic arithmetic, access control, and handling optionals and errors

ryanwaits avatar Jul 27 '24 18:07 ryanwaits

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 20, 2024 0:22am

vercel[bot] avatar Jul 27 '24 18:07 vercel[bot]

On the overview page for Clarity, in the Function categories cards, the cryptographic functions and the time-based logic cards have broken sidebars. Once I click into those guides, the left hand side shows Bitcoin, guides, and stacks.

These pages should just show the Clarity side bar.

Also on the note of the sidebar, should these 4 guides be linked there under Advanced or below introduction?

max-crawford avatar Aug 19 '24 21:08 max-crawford

Once I click into those guides, the left hand side shows Bitcoin, guides, and stacks.

ah good catch - those were meant to be hidden (as you can see they don't appear on the sidebar). I forgot about the cards on the intro page that link to them. I've updated the intro page to not link to these guides since they are not complete.

Also on the note of the sidebar, should these 4 guides be linked there under Advanced or below introduction?

I updated that section to be a Guides section, and sit above the Functions section.

cc @max-crawford

ryanwaits avatar Aug 19 '24 21:08 ryanwaits