-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
173 changed files
with
20,171 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| name: Wiki content | ||
| about: Request a new content missing in the wiki | ||
| title: '' | ||
| labels: 'feature' | ||
| assignees: '' | ||
| --- | ||
|
|
||
| ## What content is missing? | ||
|
|
||
| ## Related content in the wiki | ||
|
|
||
| ## Other relevant resources | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| ## Wiki PR Checklist | ||
|
|
||
| Thank you for contributing to the Protocol Wiki! Before you open a PR, make sure to read [information for contributors](https://epf.wiki/#/contributing) and take a look at following checklist: | ||
|
|
||
| - [ ] Describe your changes, substitute this text with the information | ||
| - [ ] If you are touching an existing piece of content, ask the original creator for review | ||
| - [ ] If you need feedback for your content from wider community, share the PR in our Discord | ||
| - [ ] Review changes to ensure there are no typos, see instructions bellow | ||
|
|
||
| <!-- | ||
| ℹ️ Checking for typos locally | ||
| 1. Install [aspell](https://www.gnu.org/software/aspell/) for your platform. | ||
| 2. Navigate to the project root and run: | ||
| ``` | ||
| for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list < $f | sort | uniq -c ; done | ||
| ``` | ||
| ℹ️ Fixing typos | ||
| 1. Fix typos: Open the relevant files and fix any identified typos. | ||
| 2. Update wordlist: If a flagged word is actually a project-specific term add it to `wordlist.txt` in the project root. | ||
| Each word should be listed on a separate line. | ||
| * 🚧 Remember: | ||
| * When adding new words it must NOT have any spaces or special characters within or around it. | ||
| * \`wordlist\` is NOT case sensitive. | ||
| * Use backticks to quote code variables so as to not bloat the \`wordlist\`. | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Markdown linter | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| lint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: DavidAnson/markdownlint-cli2-action@v15 | ||
| continue-on-error: true | ||
| with: | ||
| globs: | | ||
| docs/wiki/*.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| name: 🥢 Spell check | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| typo_check: | ||
| name: 🥢 Spell check | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| env: | ||
| TYPOS: "" | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.event.pull_request.head.sha }} | ||
| fetch-depth: 2 | ||
|
|
||
| - name: Install aspell | ||
| run: sudo apt-get update && sudo apt-get install -y aspell | ||
|
|
||
| - name: Find and check typos in Markdown files | ||
| id: find_typos | ||
| run: | | ||
| echo "Checking for typos..." | ||
| # https://unix.stackexchange.com/a/9500 | ||
| IFS=$'\n' | ||
| set -f | ||
| for file in $(find . -name "*.md" ); do | ||
| output="$(aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case list <$file)" | ||
| echo "$output" | ||
| # Exit if aspell has errors | ||
| if [ $? -ne 0 ]; then | ||
| exit 1 | ||
| fi | ||
| if [[ -n "$output" ]]; then | ||
| # Format output. | ||
| output=$(echo "$output" | sed 's/^/ 1. /') | ||
| TYPOS+="- 📄 $file:" | ||
| TYPOS+=$'\n' | ||
| TYPOS+="$output" | ||
| TYPOS+=$'\n' | ||
| fi | ||
| done | ||
| { | ||
| echo 'TYPOS<<EOF' | ||
| echo "$TYPOS" | ||
| echo EOF | ||
| } >> "$GITHUB_ENV" | ||
| - name: Comment on pull request | ||
| if: env.TYPOS != '' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| const author = '${{github.event.pull_request.user.login}}'; | ||
| const typos = `${{ env.TYPOS }}`; | ||
| const body = ` | ||
| Hi @${author}, | ||
| Following typos were found in the pull request: | ||
| ${typos} | ||
| ## ℹ️ Here's how to fix them: | ||
| - **Fix typos:** Open the relevant files and fix any identified typos. | ||
| - **Update wordlist:** If a flagged word is actually a project-specific term add it to \`wordlist.txt\` in the project root. | ||
| Each word should be listed on a separate line. [Learn more.](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html) | ||
| - **🚧 Remember:** | ||
| - When adding new words it MUST NOT have any spaces or special characters within or around it. | ||
| - \`wordlist\` is NOT case sensitive. | ||
| - Use backticks to quote code variables so as to not bloat the \`wordlist\`. | ||
| `; | ||
| github.rest.issues.createComment({ | ||
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: body | ||
| }); | ||
| core.setFailed('🥢 Spell check: Typos found in docs. Please fix them.'); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,4 +3,6 @@ | |
| **/.vscode | ||
| **/.vscode? | ||
| **/.obsidian | ||
| **/.obsidian? | ||
| **/.obsidian? | ||
| **/.idea | ||
| **/.idea? | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| epf.wiki |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| --- | ||
| Wiki created by <a href="https://twitter.com/joshdavislight">Josh Davis</a> and <a href="https://twitter.com/TMIYChao">Mário Havel</a> from Protocol Support, maintained by EPFsg community. <a rel="license" href="https://github.com/eth-protocol-fellows/protocol-studies/blob/main/LICENSE"><img alt="CC License" style="border-width:0" src="https://licensebuttons.net/l/by-sa/4.0/88x31.png" /></a><br/> This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International.</a>. | ||
| EPF Wiki initiated by EF Protocol Support and maintained by EPFsg community. <a rel="license" href="https://github.com/eth-protocol-fellows/protocol-studies/blob/main/LICENSE"><img alt="CC License" style="border-width:0" src="https://licensebuttons.net/l/by-sa/4.0/88x31.png" /></a><br/> This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International.</a>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| * [Home](readme.md) | ||
| * [Study Group](study-group.md) | ||
| * [Study Group](/eps/intro.md) | ||
| * [Contribute](contributing.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.