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

chore(sdk): Update passkeys documentation #649

Merged
merged 19 commits into from
Dec 10, 2024
Merged

chore(sdk): Update passkeys documentation #649

merged 19 commits into from
Dec 10, 2024

Conversation

yagopv
Copy link
Member

@yagopv yagopv commented Nov 25, 2024 •
edited
Loading

We are updating the passkeys guide and protocol-kit reference section after implementing compatibility with React Native

@yagopv yagopv requested a review from germartinez November 25, 2024 16:08
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 25, 2024 •
edited
Loading

Branch preview

✅ Deployed successfully in branch deployment:

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 25, 2024 •
edited
Loading

Overall readability score: 30.79 (🟢 +0.13)

File Readability
createpasskeysigner.mdx 60.13 (-)
passkeys.mdx 34.42 (🟢 +7.73)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
createpasskeysigner.mdx 60.13 53.88 7.3 11 14 8.47
  - - - - - -
passkeys.mdx 34.42 39.4 16.02 20.3 11.21 8.09
  🟢 +7.73 🟢 +4.46 🟢 +1.71 🟢 +1.7 🔴 -0.17 🟢 +0.57

Averages:

  Readability FRE GF ARI CLI DCRS
Average 30.79 26.84 13.64 17.76 15.83 8.97
  🟢 +0.13 🟢 +0.11 🟢 +0.03 🟢 +0.03 🟢 +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

@yagopv yagopv changed the title chore(sdk): Update passkeys chore(sdk): Update passkeys documentation Nov 25, 2024
@yagopv yagopv linked an issue Nov 25, 2024 that may be closed by this pull request
[React Native] Update docs safe-global/safe-core-sdk#1051
Open
germartinez
germartinez requested changes Nov 26, 2024
View reviewed changes
pages/sdk/signers/passkeys.mdx Outdated Show resolved Hide resolved
pages/sdk/signers/passkeys.mdx Outdated Show resolved Hide resolved
pages/sdk/signers/passkeys.mdx Outdated Show resolved Hide resolved
@yagopv yagopv requested a review from germartinez December 2, 2024 12:29
germartinez
germartinez reviewed Dec 4, 2024
View reviewed changes
pages/sdk/signers/passkeys.mdx Outdated Show resolved Hide resolved
pages/sdk/signers/passkeys.mdx Outdated Show resolved Hide resolved
yarn.lock Outdated Show resolved Hide resolved
@germartinez germartinez self-requested a review December 4, 2024 12:29
@yagopv yagopv mentioned this pull request Dec 4, 2024
Closed
1 task
@yagopv yagopv merged commit da55547 into development Dec 10, 2024
3 checks passed
@yagopv yagopv deleted the sdk-update-passkeys-guide branch December 10, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@germartinez germartinez germartinez approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[React Native] Update docs
2 participants
@yagopv @germartinez