-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: clarity documentation #721
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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? |
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.
I updated that section to be a Guides section, and sit above the Functions section. |
tweaked copy on the overview
updated copy on cards for guides
voice/grammar tweaks
grammar tweaks
capitalization tweak
grammar tweaks
capitalization tweak
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made some tweaks. Still want to do a copy pass on the individual functions, but that is not a blocker to getting this live in prod. Approved!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
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.