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

Update Safe Apps section #267

Merged
merged 16 commits into from
Oct 27, 2023
Merged

Update Safe Apps section #267

merged 16 commits into from
Oct 27, 2023

Conversation

tanay1337
Copy link
Collaborator

No description provided.

@github-actions
Copy link

github-actions bot commented Oct 27, 2023 •
edited
Loading

Overall readability score: 69.13 (🟢 +0.77)

File Readability
get-started.md 74.62 (-)
README.md 69.42 (🔴 -3.09)
release.md 69.46 (-)
SUMMARY.md 100 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
get-started.md 74.62 65.52 9.16 8.1 8.87 7.13
  - - - - - -
README.md 69.42 66.03 9.71 9 9.97 7.59
  🔴 -3.09 🔴 -0.51 🔴 -0.38 🔴 -0.5 🔴 -0.47 🔴 -0.3
release.md 69.46 61.87 10.87 9.2 8.52 7.29
  - - - - - -
SUMMARY.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 69.13 59.52 9.18 9.59 10.51 7.13
  🟢 +0.77 🟢 +0.41 🟢 +0.19 🟢 +0.12 🟢 +0 🟢 +0.06
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

@tanay1337 tanay1337 marked this pull request as ready for review October 27, 2023 11:49
@tanay1337 tanay1337 requested a review from germartinez October 27, 2023 11:49
germartinez
germartinez requested changes Oct 27, 2023
View reviewed changes
Copy link
Member

@germartinez germartinez left a comment

Choose a reason for hiding this comment

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

As a general comment, when files are renamed and updated it's difficult to track changes unless renaming them and updating them are done in different PRs. In future scenarios like this one, I think it would be helpful to squash all the commits with the changes and all the commits with the renaming to end up having just 2 commits in the PR. That would facilitate the review :)

safe-apps/release.md Outdated Show resolved Hide resolved
safe-apps/release.md Outdated Show resolved Hide resolved
safe-apps/release.md Outdated Show resolved Hide resolved
tanay1337 and others added 3 commits October 27, 2023 15:48
@tanay1337 @germartinez
Update safe-apps/release.md
9d5aa99 
Co-authored-by: Germán Martínez <[email protected]>
@tanay1337 @germartinez
Update safe-apps/release.md
271ad7e 
Co-authored-by: Germán Martínez <[email protected]>
@tanay1337 @germartinez
Update safe-apps/release.md
d296d9f 
Co-authored-by: Germán Martínez <[email protected]>
@tanay1337 tanay1337 requested a review from germartinez October 27, 2023 13:49
@tanay1337 tanay1337 merged commit bbbd890 into main Oct 27, 2023
2 of 4 checks passed
@tanay1337 tanay1337 deleted the safe-apps-updates branch October 27, 2023 13:52
louis-md added a commit that referenced this pull request Jan 24, 2024
@louis-md @tanay1337
@germartinez @xiaolou86 @iamacook @DaniSomoza @dasanra @heypran @yagopv
Nextra POC (#290)
d810ad3 
* Update SUMMARY.md (#251)

* Update SUMMARY.md

* Update SUMMARY.md

* Add GH action for readability (#254)

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add workflow for style check on PRs (#255)

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Update workflow setting

* Add link check workflow (#257)

* Add link check workflow

* Fix errors

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Remove link check GH action

* Link check workflow (#259)

* Link check workflow

* Test a fix

* Updates

* Fixes

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add weekly link checker (#260)

* Add weekly link checker

* Minor updates

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add manual trigger for testing

* Fix conditional for issue creation

* Update conditional for workflow

* Minor updates to the workflow

* Update information architecture (#265)

* Update information architecture

* Update minimum alert level for Vale

* Remove unused files

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Update Safe Apps section (#267)

* Update Safe Docs

* Update README.md

* Add new vocabulary

* Update README.md

* Update get-started.md

* Update get-started.md

* Add new vocab

* Update release.md

* Update release.md

* Add new vocab

* New words

* Update release.md

* Update release.md

* Update safe-apps/release.md

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

* Update safe-apps/release.md

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

* Update safe-apps/release.md

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

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: Germán Martínez <[email protected]>

* Update IA for reference (#268)

* Update IA

* Fixes

* Move files around

* Update SUMMARY.md

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* docs: fix typos (#271)

* docs: fix typos

* Update safe-apps/release.md

revert typo walkthroughts

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

* Update safe-core-api/rpc-requirements.md

fix typos

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

* Update safe-core-api/rpc-requirements.md

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

* Update safe-core-api/rpc-requirements.md

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

* Update safe-core-api/rpc-requirements.md

fix typos

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

* Update safe-apps/release.md

fix typo

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

---------

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

* fix: update `@web3auth/*` versions (#270)

* fix: update `@web3auth/*` versions

* fix: revert formatting

* Update README.md (#276)

* Add script to generate Supported Networks pages from safe-deployments repo as a github action (#278)

* Add script to genereate Supported Networks pages from safe-deployments repo as a github action

* Update summary

* Update summary

* Fix typo in supported networks script & re-generate .md files

* Implement requested changes

* Implement requested changes

* Remove unused console.log; fix supported networks index page & block explorers

* Fix some vale errors ("networks's" & "Testnet")

* Re-generate supported networks

* Implement requested changes (wording & correct section)

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Move supported networks .md folder into safe-smart-accounts

* Implement requested changes (create PR on workflow, minor fixes)

* Update vale dictionnary

* Update vale dictionnary

* Remove duplicates in vale dictionnary

* Remove unnecessary steps in github workflow for supported networks

* Remove duplicates in vale dictionnary

* Alphabetize & deduplicate vale dictionnary

* Exclude deprecated block explorer from supported networks page generation

---------

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

* Link checks (#275)

* Fix some link checker errors

* Fix some link checker errors

* Fix some link checker errors

* Add Pimlico to Safe Modules (#279)

* Update modules.md

* Update accept.txt

* Update weekly-link-check.yml (#281)

* Revert "Update weekly-link-check.yml (#281)" (#283)

This reverts commit 4d2f19d.

* Link fixes (#284)

* Update README.md

* Update MoneriumPack.md

* Link checks (#285)

* Fix some link checker errors

* Fix some link checker errors

* Fix some link checker errors

* Fix broken links

* Re-generate .md files

* protocol-kit v2.0 (#266)

* update ethers docs

* add singleton change to api-kit and protocol-kit
update api-kit initialization
update createTransaction use

* update GelatoRelayKit breaking changes

* fix wording recommendations

* highlight ethers.js v6

* add migration guides highlighting the major changes

---------

Co-authored-by: Daniel <[email protected]>

* Switch from gitbook to nextra

* Migrate getting started section

* Migrate assets

* Migrate misc section

* Migrate safe-apps section

* Migrate safe-core-api section

* Migrate safe-core-sdk section

* Migrate safe-smart-account section

* Migrate safe-core-protocol section

* Add index page

* Update generate supported network script

* Fix broken links & vale errors

* Fix vale errors

* Fix vale errors

* Fix vale errors

* Reorder sidebar (#292)

* Update SUMMARY.md

* Update and rename available-services.md to supported-networks.md

* Implement design feedback (color palette, font)

* Add torusscan as a deprecated block explorer in generateSupportedNetworks

* Add footer from safe.global

* Remove Home component; redirect index to first page

* Implement design feedback (navbar background color & backdrop filter)

* Add legacy `safe-core-sdk` migration guide (#291)

* update ethers docs

* add singleton change to api-kit and protocol-kit
update api-kit initialization
update createTransaction use

* Fix linting and typos

* fix: broken links

* update GelatoRelayKit breaking changes

* improve parameter naming

* fix linter reported issue

* fix wording recommendations

* highlight ethers.js v6

* add migration guides highlighting the major changes

* fix typos

* Apply suggestions from code review

Co-authored-by: Tanay Pant <[email protected]>

* add backticks to EthersAdapter

* Apply suggestions from code review

Co-authored-by: Tanay Pant <[email protected]>

* set migrating guides below reference

* add wording suggestions

* Add safe-transaction-service migration guide

* Add migration guide from legacy safe-core-sdk

* Add types changes

* remove auth-kit changes

* fix linting issues

* improve api-kit v2 migration

* Add latest changes

* Add missing type

* fix typo

* Apply suggestions from code review

Co-authored-by: Tanay Pant <[email protected]>

* add migration links

* Update safe-core-sdk/protocol-kit/reference/migrating/v1.md

Co-authored-by: Tanay Pant <[email protected]>

* Reverse migration links order in SUMMARY

---------

Co-authored-by: Daniel Somoza <[email protected]>
Co-authored-by: Tanay Pant <[email protected]>

* Add middleware information for Safe Apps (#293)

* Update get-started.md

* Update accept.txt

* Fix information architecture

* Fix error in code snippet (#295)

* Fix all images &  callouts

* Collapse sidebar menu items

* Add deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* docs(auth-kit): Update docs for the new `SafeAuthPack` (#289)

* add protocol-kit v2 updates

* Add SafeAuth information

* Update ethersv6 changes

* Fix deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* fix broken links (#296)

* fix broken links

* fix: link name

* Minor fixes

* chore: Improve auth-kit docs (#298)

* Fix broken links

* Force dark theme

* Fix generate supported networks

* Add avax.boba.network as deprecated block explorers

* Fix generate supported networks (#299)

* Fix generate supported networks

* Generate supported networks .md files

* Edit vocab

* Add toruscan as deprecated block explorer

* Add favicon; fix theme color.

* Cherry pick merged changes from #289

* Cherry pick merged changes from #291

* Cherry pick merged changes from subsequent PRs

* Fix link checker & vale errors

* Add eslint, standard, husky

* Fix lint errors

* Fix pre-push commit hook

* Fix theme import

* Set Google Form for first Safe App review contact (#303)

* Feedback widget design. WIP logic

* Add google analytics

* Move contact-us links in footer

* Rename all files with prefixes

* Add local link checker to prepush hook

* Minor fix

* Fix vale config

* Add missing content from `main`

* Add redirections from gitbook paths

* Fix eslint config

* Remove linkchecker from prepush hook

* Add legacy redirects

* Custom 404 page

* Fix breaking changes in vale v3

* fix: link view inside hint element not showing as expected (#307)

* Restore signature files (#308)

* Restore signatures

* Fix link

* Fix conflicts with signatures

* Update gitignore

* Fix Vale errors

* Accept words with Vale

* Fix vale errors; add vale to lint command.

* Fix build

* Fix redirect link

* Implement requested changes

* Add redirections test

* Fix tsconfig

* Fix typos in redirects

* Fix typo in redirects

* Switch all routes to kebab-case

---------

Co-authored-by: Tanay Pant <[email protected]>
Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: Germán Martínez <[email protected]>
Co-authored-by: xiaolou86 <[email protected]>
Co-authored-by: Aaron Cook <[email protected]>
Co-authored-by: Dani Somoza <[email protected]>
Co-authored-by: Daniel <[email protected]>
Co-authored-by: Daniel Somoza <[email protected]>
Co-authored-by: Pran <[email protected]>
Co-authored-by: Yago Pérez Vázquez <[email protected]>
Co-authored-by: Germán Martínez <[email protected]>
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.
2 participants
@tanay1337 @germartinez