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

docs: Passkeys in the SDK references #495

Merged
merged 6 commits into from
Jun 7, 2024
Merged

Conversation

DaniSomoza
Copy link
Contributor

docs: Passkeys in the SDK references

Copy link

github-actions bot commented Jun 5, 2024

Branch preview

✅ Deployed successfully in branch deployment:

https://passkey_reference--docs.review.5afe.dev

Copy link

github-actions bot commented Jun 5, 2024

Overall readability score: 56.53 (🟢 +0.04)

File Readability
safe-factory.md 61.54 (🟢 +0.77)
safe.md 72.68 (🟢 +2.28)
safe-4337-pack.mdx 60.63 (🟢 +0.12)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
safe-factory.md 61.54 55.03 10.41 11.1 11.37 7.54
  🟢 +0.77 🔴 -0.1 🟢 +0.06 🟢 +0.2 🟢 +0.23 🟢 +0.02
safe.md 72.68 50.84 7.01 10.3 12.11 5.71
  🟢 +2.28 🟢 +8.36 🟢 +0.06 🟢 +0.1 🟢 +0.35 🟢 +0.05
safe-4337-pack.mdx 60.63 34.02 8.13 11.6 14.2 6.49
  🟢 +0.12 🔴 -0.1 🔴 -0.03 🟢 +0.1 🟢 +0.05 🔴 -0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.53 49.35 10.77 12.53 12.25 7.58
  🟢 +0.04 🟢 +0.1 🟢 +0 🟢 +0 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@germartinez germartinez self-requested a review June 5, 2024 23:56
pages/sdk/relay-kit/reference/safe-4337-pack.mdx Outdated Show resolved Hide resolved
pages/sdk/protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk/protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk/protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk/protocol-kit/reference/safe-factory.md Outdated Show resolved Hide resolved
@germartinez germartinez changed the base branch from development to passkeys June 7, 2024 11:10
@germartinez germartinez merged commit 3a999f6 into passkeys Jun 7, 2024
3 checks passed
@germartinez germartinez deleted the passkey-reference branch June 7, 2024 11:10
tanay1337 pushed a commit that referenced this pull request Jun 14, 2024
* docs: Passkeys in the SDK references (#495)

* add passkeys in the doc references

* Update pages/sdk/protocol-kit/reference/safe-factory.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/relay-kit/reference/safe-4337-pack.mdx

Co-authored-by: Germán Martínez <[email protected]>

---------

Co-authored-by: Germán Martínez <[email protected]>

* docs: Add Passkeys section, overview and guide (#498)

* Add Passkeys section

* Add Passkeys overview

* Add passkeys guide

* Create missing pages

* Update steps style in Passkeys guide

* fix: copy edits

* feat: add safe and passkeys section

* fix: vale errors

* fix: formatting error

* fix: updates based on feedback

* feat: add flow diagram

* fix: minor update

* Add passkeys tutorial

* Minor fixes to passkeys tutorial

* Fix vale errors

* Fix screenshots

* Fix screenshots

* fix: minor edits

* fix: minor edits

* Minor fixes

* fix: correct term

* Add passkeys FAQs

* Minor fixes

* fix: remove mermaid diagram

* add: supported networks

* fix: add the correct url

* fix: get ready for release

---------

Co-authored-by: Dani Somoza <[email protected]>
Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: louis-md <[email protected]>
louis-md added a commit that referenced this pull request Jul 5, 2024
* docs: Passkeys in the SDK references (#495)

* add passkeys in the doc references

* Update pages/sdk/protocol-kit/reference/safe-factory.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/protocol-kit/reference/safe.md

Co-authored-by: Germán Martínez <[email protected]>

* Update pages/sdk/relay-kit/reference/safe-4337-pack.mdx

Co-authored-by: Germán Martínez <[email protected]>

---------

Co-authored-by: Germán Martínez <[email protected]>

* docs: Add Passkeys section, overview and guide (#498)

* Add Passkeys section

* Add Passkeys overview

* Add passkeys guide

* Create missing pages

* Update steps style in Passkeys guide

* fix: copy edits

* feat: add safe and passkeys section

* fix: vale errors

* fix: formatting error

* fix: updates based on feedback

* feat: add flow diagram

* fix: minor update

* Add passkeys tutorial

* Minor fixes to passkeys tutorial

* Fix vale errors

* Fix screenshots

* Fix screenshots

* fix: minor edits

* fix: minor edits

* Minor fixes

* fix: correct term

* Add passkeys FAQs

* Minor fixes

* feat: add new chains

* Fix typo

* Fix styling

* fix: correct based on feedback

* feat: add api reference for passkeys remove and swap owners (#505)

* Fix typo in tutorial layout

* Get tutorial code examples from github

* Update 7579 code examples

* Move passkeys code examples outside of the /pages folder

* Add developer preview notice in 7579 and passkeys tutorials

---------

Co-authored-by: Dani Somoza <[email protected]>
Co-authored-by: Germán Martínez <[email protected]>
Co-authored-by: Germán Martínez <[email protected]>
Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: leonardotc <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants