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.

Sign up for GitHub

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

Jump to bottom

use descriptive link text for the zkApp Developers topics #407

Merged
merged 15 commits into from
Jun 1, 2023
Merged

use descriptive link text for the zkApp Developers topics #407

merged 15 commits into from
Jun 1, 2023

Conversation

barriebyron
Copy link
Contributor

part of #291 this work introduces accurate, descriptive phrases that provide helpful context to links in our docs.

This PR:

  • uses descriptive link text for the zkApps Developers topics
  • replaces HTML links with Markdown style for easier maintenance
  • Cleans up language and reduces wordiness

@barriebyron barriebyron self-assigned this May 23, 2023
@vercel
Copy link

vercel bot commented May 23, 2023 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 1, 2023 5:07pm

@barriebyron barriebyron added docs Improvements or additions to documentation style Non-technical editorial and style guidance updates zkApps Focused zkApps content labels May 23, 2023
@barriebyron barriebyron marked this pull request as ready for review May 24, 2023 18:50
@barriebyron barriebyron requested a review from a team as a code owner May 24, 2023 18:50
mitschabaude
mitschabaude reviewed May 25, 2023
View reviewed changes
Copy link
Contributor

@mitschabaude mitschabaude left a comment

Choose a reason for hiding this comment

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

Nice changes, I have a couple of comments, some fixes to links as well. Would be nice if you can get the deployment working (maybe it was the links?)

docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/index.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-zkapps-work.mdx Outdated Show resolved Hide resolved
docs/zkapps/index.mdx Outdated Show resolved Hide resolved
barriebyron and others added 2 commits May 25, 2023 10:44
ymekuria
ymekuria reviewed May 31, 2023
View reviewed changes
Copy link
Contributor

@ymekuria ymekuria left a comment

Choose a reason for hiding this comment

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

Nice @barriebyron! I left some comments

docs/zkapps/how-to-write-a-zkapp-ui.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Show resolved Hide resolved
docs/zkapps/how-to-write-a-zkapp.mdx Outdated Show resolved Hide resolved
@barriebyron barriebyron requested a review from ymekuria June 1, 2023 17:04
ymekuria
ymekuria approved these changes Jun 1, 2023
View reviewed changes
Copy link
Contributor

@ymekuria ymekuria left a comment

Choose a reason for hiding this comment

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

Looks great @barriebyron. I just had one question but I approved this.

docs/zkapps/how-to-write-a-zkapp.mdx Show resolved Hide resolved
ymekuria
ymekuria approved these changes Jun 1, 2023
View reviewed changes
Copy link
Contributor

@ymekuria ymekuria left a comment

Choose a reason for hiding this comment

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

Looks great @barriebyron. I just had one question but I approved this.

@barriebyron barriebyron merged commit 167336a into main Jun 1, 2023
@barriebyron barriebyron deleted the zkapp-descriptive-links-2 branch June 1, 2023 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ymekuria ymekuria ymekuria approved these changes

@mitschabaude mitschabaude Awaiting requested review from mitschabaude

Assignees

@barriebyron barriebyron

Labels
docs Improvements or additions to documentation style Non-technical editorial and style guidance updates zkApps Focused zkApps content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@barriebyron @ymekuria @mitschabaude