Add glossary page #286

louis-md · 2023-11-24T16:09:57Z

No description provided.

* Update SUMMARY.md * Update SUMMARY.md

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

* Add link check workflow * Fix errors --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Link check workflow * Test a fix * Updates * Fixes --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add weekly link checker * Minor updates --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Update information architecture * Update minimum alert level for Vale * Remove unused files --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* 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 * Fixes * Move files around * Update SUMMARY.md --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* 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 * fix: revert formatting

… 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]>

* Fix some link checker errors * Fix some link checker errors * Fix some link checker errors

* Update modules.md * Update accept.txt

This reverts commit 4d2f19d.

* Update README.md * Update MoneriumPack.md

* Fix some link checker errors * Fix some link checker errors * Fix some link checker errors * Fix broken links * Re-generate .md files

github-actions · 2023-11-24T16:10:17Z

Overall readability score: 70.34 (🔴 -0.18)

File	Readability
glossary.md	60.93 (-)
SUMMARY.md	100 (🟢 +0)

View detailed metrics

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

File	Readability	FRE	GF	ARI	CLI	DCRS
glossary.md	60.93	45.25	9.73	12.4	12.35	6.57
	-	-	-	-	-	-
SUMMARY.md	100	100	6	6	6	4.9
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	70.34	61.5	9.15	9.54	10.31	6.97
	🔴 -0.18	🔴 -0.31	🔴 -0.01	🔴 -0.05	🔴 -0.04	🟢 +0.01

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

* 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]>

* Update get-started.md * Update accept.txt

* add protocol-kit v2 updates * Add SafeAuth information * Update ethersv6 changes

* fix broken links * fix: link name

miscellaneous/glossary.md

* Fix generate supported networks * Generate supported networks .md files * Edit vocab * Add toruscan as deprecated block explorer

…glossary

…ing)

…erlinking)

.github/styles/Vocab/default/accept.txt

miscellaneous/glossary.md

tanay1337 and others added 26 commits October 17, 2023 16:39

Update SUMMARY.md (#251)

f71a7b1

* Update SUMMARY.md * Update SUMMARY.md

Add GH action for readability (#254)

866bcaf

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

Add workflow for style check on PRs (#255)

c42e78e

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

Update workflow setting

dc399b3

Add link check workflow (#257)

f665bf1

* Add link check workflow * Fix errors --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

Remove link check GH action

ac4df31

Link check workflow (#259)

457a4a5

* Link check workflow * Test a fix * Updates * Fixes --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

Add weekly link checker (#260)

d743b34

* Add weekly link checker * Minor updates --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

Add manual trigger for testing

425dbb8

Fix conditional for issue creation

6071df8

Update conditional for workflow

942de0c

Minor updates to the workflow

4e9e445

Update information architecture (#265)

0f562ae

* Update information architecture * Update minimum alert level for Vale * Remove unused files --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

Update IA for reference (#268)

78e743d

* Update IA * Fixes * Move files around * Update SUMMARY.md --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

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

b2a2ad0

* fix: update `@web3auth/*` versions * fix: revert formatting

Update README.md (#276)

6fbe44a

Link checks (#275)

ba3e227

* Fix some link checker errors * Fix some link checker errors * Fix some link checker errors

Add Pimlico to Safe Modules (#279)

0e7c0e7

* Update modules.md * Update accept.txt

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

4d2f19d

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

e5becc9

This reverts commit 4d2f19d.

Link fixes (#284)

c32fcf9

* Update README.md * Update MoneriumPack.md

Link checks (#285)

ee0962d

* Fix some link checker errors * Fix some link checker errors * Fix some link checker errors * Fix broken links * Re-generate .md files

Add glossary page

72c6f9b

louis-md requested a review from tanay1337 November 24, 2023 16:10

louis-md and others added 2 commits November 24, 2023 17:11

Fox dead link in glossary

1c9fe73

tanay1337 and others added 6 commits November 30, 2023 09:36

Add middleware information for Safe Apps (#293)

a175bad

* Update get-started.md * Update accept.txt

Fix error in code snippet (#295)

e6db49c

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

f660d7b

* add protocol-kit v2 updates * Add SafeAuth information * Update ethersv6 changes

fix broken links (#296)

2ff1ae0

* fix broken links * fix: link name

Minor fixes

da1a510

chore: Improve auth-kit docs (#298)

01bbe4f

germartinez reviewed Dec 5, 2023

View reviewed changes

louis-md added 10 commits December 5, 2023 17:44

Fix generate supported networks (#299)

6afed64

* Fix generate supported networks * Generate supported networks .md files * Edit vocab * Add toruscan as deprecated block explorer

Merge branch 'main' of https://github.com/safe-global/safe-docs into …

b999977

…glossary

Implement requested changes (wording, vale, grammarly, some interlink…

52df0f7

…ing)

Edit glossary wording

1d49be0

Fix typos, vale errors and wording in glossary

be7711f

Fix link checker error in glossary

c49abe7

Implement requested changes in glossary (wording, new words, more int…

9c58e84

…erlinking)

Fix link checker & vale errors; add EIP 712, 1271 & ERC 4337

9b412d0

Implement requested changes in glossary (wording, new words, more int…

4673172

…erlinking)

Fix vale errors

34d8126

germartinez reviewed Dec 20, 2023

View reviewed changes

.github/styles/Vocab/default/accept.txt Outdated Show resolved Hide resolved

Alphabetize and make some vocab words case insensitive

6f74b67