Skip to content
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

Merged
merged 23 commits into from
Aug 20, 2024
Merged

feat: clarity documentation #721

merged 23 commits into from
Aug 20, 2024

Conversation

ryanwaits
Copy link
Collaborator

@ryanwaits ryanwaits commented Jul 27, 2024

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.

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

@ryanwaits ryanwaits self-assigned this Jul 27, 2024
Copy link

vercel bot commented Jul 27, 2024

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

@ryanwaits ryanwaits changed the title clarity function initiative clarity functions Jul 28, 2024
@ryanwaits ryanwaits changed the title clarity functions Clarity Functions Jul 28, 2024
@ryanwaits ryanwaits changed the title Clarity Functions feat: clarity documentation Aug 13, 2024
@max-crawford
Copy link
Contributor

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?

@ryanwaits
Copy link
Collaborator Author

ryanwaits commented Aug 19, 2024

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

tweaked copy on the overview
updated copy on cards for guides
voice/grammar tweaks
capitalization tweak
Copy link
Contributor

@max-crawford max-crawford left a 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!

Copy link
Contributor

@ECBSJ ECBSJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ryanwaits ryanwaits merged commit 409f811 into main Aug 20, 2024
4 checks passed
@ryanwaits ryanwaits deleted the feat/clarity-initiative branch August 20, 2024 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants