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

fix: replace ClientSDK with Mina Signer in client-sdk.mdx #443

Merged
merged 8 commits into from
Jun 26, 2023

Conversation

barriebyron
Copy link
Contributor

@barriebyron barriebyron commented Jun 22, 2023

This PR started to fix a broken link because the Client SDK is now deprecated and is superseded by MinaSigner
So then the scope expanded to address quality opportunities(including case, consistency, style, capitalization, SNARK worker instances - see the Docs Style Guide for guidance, especially the Word List

  • Replace the current Client SDK topic with a new Mina Signer topic that links to the repo with install and usage instructions
  • Update the Node Operator FAQ topic to describe Mina Signer and mention deprecation, add description of zkApp, and update known errors

Mina friends! Please review updates to ensure I didn't inadvertently introduce technical inaccuracies

Questions? Please ask

As always, Mina docs contributions are most welcome (and much needed)

@barriebyron barriebyron added the docs Improvements or additions to documentation label Jun 22, 2023
@barriebyron barriebyron self-assigned this Jun 22, 2023
@barriebyron barriebyron requested a review from a team as a code owner June 22, 2023 18:01
@vercel
Copy link

vercel bot commented Jun 22, 2023

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 26, 2023 1:30pm

@barriebyron
Copy link
Contributor Author

@MartinMinkov do we need a redirect here? and if so, how do redirects work?

@MartinMinkov
Copy link
Collaborator

@MartinMinkov do we need a redirect here? and if so, how do redirects work?

Yes, good catch! You can add one by adding the following code in our docusaurus.config.js file

{
  from: '/node-operators/client-sdk',
  to: '/node-operators/mina-signer',
},

@barriebyron barriebyron merged commit f1d6a81 into main Jun 26, 2023
2 checks passed
@barriebyron barriebyron deleted the barriebyron-patch-1 branch June 26, 2023 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants