Bump webrick from 1.8.1 to 1.8.2

.devcontainer/devcontainer.json

@@ -0,0 +1,5 @@
+{
+  "tasks": {
+    "build": "gem install bundler && bundle install"
+  }
+}

.github/CONTRIBUTING.md

@@ -1,3 +1,16 @@
 Please review [EIP-1](https://eips.ethereum.org/EIPS/eip-1) for EIP guidelines.
 
 <!-- RATIONALE FOR THIS FILE: IT IS DISPLAYED WHEN YOU CREATE AN ISSUE OR MAKE A PR -->
+
+## Consistency in Style and Terminology
+
+To ensure consistency in style and terminology throughout the documentation, please follow these guidelines:
+
+* Use the same terminology and phrasing as found in existing documentation.
+* Maintain a consistent tone and style in your writing.
+* Use proper formatting for headings, subheadings, and bullet points.
+* Ensure that all links and references are accurate and up-to-date.
+
+## Continuous Improvement
+
+We encourage feedback and continuous improvement of the documentation. If you have any suggestions or notice any issues, please open an issue or submit a pull request with your proposed changes.

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
 ATTENTION! If you would like to submit an EIP and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls).
 
-If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion.  Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.
+If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion. Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.
 
 Keep in mind the following guidelines from [EIP-1](https://eips.ethereum.org/EIPS/eip-1):
 
@@ -9,3 +9,16 @@ Keep in mind the following guidelines from [EIP-1](https://eips.ethereum.org/EIP
 > Vetting an idea publicly before going as far as writing an EIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used.
 
 > Once the champion has asked the Ethereum community as to whether an idea has any chance of acceptance, a draft EIP should be presented as a Pull Request. This gives the author a chance to flesh out the draft EIP to properly format it, ensure it is high quality, and address initial concerns about the proposal.
+
+## Consistency in Style and Terminology
+
+To ensure consistency in style and terminology throughout the documentation, please follow these guidelines:
+
+* Use the same terminology and phrasing as found in existing documentation.
+* Maintain a consistent tone and style in your writing.
+* Use proper formatting for headings, subheadings, and bullet points.
+* Ensure that all links and references are accurate and up-to-date.
+
+## Continuous Improvement
+
+We encourage feedback and continuous improvement of the documentation. If you have any suggestions or notice any issues, please open an issue or submit a pull request with your proposed changes.

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -27,3 +27,18 @@ body:
       label: Relevant log output
       description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
       render: shell
+  - type: markdown
+    attributes:
+      value: |
+        ## Consistency in Style and Terminology
+
+        To ensure consistency in style and terminology throughout the documentation, please follow these guidelines:
+
+        * Use the same terminology and phrasing as found in existing documentation.
+        * Maintain a consistent tone and style in your writing.
+        * Use proper formatting for headings, subheadings, and bullet points.
+        * Ensure that all links and references are accurate and up-to-date.
+
+        ## Continuous Improvement
+
+        We encourage feedback and continuous improvement of the documentation. If you have any suggestions or notice any issues, please open an issue or submit a pull request with your proposed changes.

.github/ISSUE_TEMPLATE/config.yml

@@ -3,3 +3,9 @@ contact_links:
   - name: Do you want to discuss EIP ideas or ask questions about the process?
     url: https://ethereum-magicians.org/
     about: Use the Fellowship of Ethereum Magicians for EIP-related discussion!
+  - name: Consistency in Style and Terminology
+    url: https://github.com/ethereum/EIPs/blob/master/.github/CONTRIBUTING.md#consistency-in-style-and-terminology
+    about: Ensure consistency in style and terminology throughout the documentation.
+  - name: Continuous Improvement
+    url: https://github.com/ethereum/EIPs/blob/master/.github/CONTRIBUTING.md#continuous-improvement
+    about: Encourage feedback and continuous improvement of the documentation.

.github/ISSUE_TEMPLATE/propose-process-change.yml

@@ -11,3 +11,19 @@ body:
       placeholder: Describe your proposed change here
     validations:
       required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Consistency in Style and Terminology
+
+        To ensure consistency in style and terminology throughout the documentation, please follow these guidelines:
+
+        * Use the same terminology and phrasing as found in existing documentation.
+        * Maintain a consistent tone and style in your writing.
+        * Use proper formatting for headings, subheadings, and bullet points.
+        * Ensure that all links and references are accurate and up-to-date.
+
+        ## Continuous Improvement
+
+        We encourage feedback and continuous improvement of the documentation. If you have any suggestions or notice any issues, please open an issue or submit a pull request with your proposed changes.

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,3 +10,16 @@ We have a GitHub bot that automatically merges some PRs. It will merge yours imm
  - The build passes.
  - Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside <triangular brackets>.
  - If matching on email address, the email address is the one publicly listed on your GitHub profile.
+
+## Consistency in Style and Terminology
+
+To ensure consistency in style and terminology throughout the documentation, please follow these guidelines:
+
+* Use the same terminology and phrasing as found in existing documentation.
+* Maintain a consistent tone and style in your writing.
+* Use proper formatting for headings, subheadings, and bullet points.
+* Ensure that all links and references are accurate and up-to-date.
+
+## Continuous Improvement
+
+We encourage feedback and continuous improvement of the documentation. If you have any suggestions or notice any issues, please open an issue or submit a pull request with your proposed changes.

.github/workflows/auto-stagnate-bot.yml

@@ -4,21 +4,21 @@ on:
     - cron:  '0 0 * * 0'
   workflow_dispatch:
 
-name: Auto Stagnant Bot
+name: Auto Stagnate Bot
 jobs:
-  auto_merge_bot:
+  auto_stagnate_bot:
     if: github.repository == 'ethereum/eips'
     runs-on: ubuntu-latest
-    name: Auto Stagnant Bot
+    name: Auto Stagnate Bot
     steps:
       - name: Checkout
         uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f
       - name: Setup Node.js Environment
         uses: actions/setup-node@d98fa1113850e562f83c7fc3a89c0ecd7a87fbed
         with:
           node-version: '14'
-      - name: auto-stagnant-bot
+      - name: auto-stagnate-bot
         uses: ethereum/EIP-Bot@b3ac0ba3600aea27157fc68d1e36c08cc5a6db77 # mark-eips-stale
-        id: auto-stagnant-bot
+        id: auto-stagnate-bot
         with:
           GITHUB-TOKEN: ${{ secrets.TOKEN }}

.github/workflows/ci.yml

@@ -129,7 +129,7 @@ jobs:
           skip: .git,Gemfile.lock,**/*.png,**/*.gif,**/*.jpg,**/*.svg,.codespell-whitelist,vendor,_site,_config.yml,style.css
 
   eipw-validator:
-    name: EIP Walidator
+    name: EIP Validator
     runs-on: ubuntu-latest
 
     steps:

.vscode/launch.json

@@ -0,0 +1,65 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "command": "npm start",
+            "name": "Run npm start",
+            "request": "launch",
+            "type": "node-terminal"
+        },
+        {
+            "name": "Launch Chrome",
+            "request": "launch",
+            "type": "chrome",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        },
+
+
+        {
+            "name": "Attach to Edge",
+            "port": 9222,
+            "request": "attach",
+            "type": "msedge",
+            "webRoot": "${workspaceFolder}"
+        },
+
+
+
+        {
+            "name": "Launch Program",
+            "program": "${workspaceFolder}/app.js",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node"
+        },
+        {
+            "name": "Launch Program",
+            "program": "${workspaceFolder}/app.js",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node"
+        },
+        {
+            "name": "Launch Chrome",
+            "request": "launch",
+            "type": "chrome",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        },
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Launch Chrome against localhost",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        }
+    ]
+}

Gemfile.lock

@@ -285,7 +285,7 @@ GEM
       unf_ext
     unf_ext (0.0.8.2)
     unicode-display_width (1.8.0)
-    webrick (1.8.1)
+    webrick (1.8.2)
     yell (2.2.2)
     zeitwerk (2.6.7)
 

README.md

@@ -85,3 +85,18 @@ eipw --config ./config/eipw.toml <INPUT FILE / DIRECTORY>
 2. Preview your local Jekyll site in your web browser at `http://localhost:4000`.
 
 More information on Jekyll and GitHub Pages [here](https://docs.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll).
+
+## Writing Effective Technical Documentation
+
+Effective technical documentation is crucial for the success of any project. Here are some key points to consider when writing technical documentation:
+
+* **Clarity and simplicity**: Ensure that the documentation is clear and easy to understand. Use simple language and avoid jargon. 📝
+* **Structure and organization**: Organize the documentation in a logical manner. Use headings, subheadings, and bullet points to break down the content into manageable sections. 📚
+* **Consistency**: Maintain consistency in terminology, formatting, and style throughout the documentation. This helps in making the document more readable and professional. 🔄
+* **Accuracy**: Ensure that the information provided is accurate and up-to-date. Regularly review and update the documentation to reflect any changes in the project. ✅
+* **Examples and visuals**: Use examples, diagrams, and screenshots to illustrate complex concepts. This helps in making the documentation more engaging and easier to understand. 🖼️
+* **User-focused**: Keep the target audience in mind while writing the documentation. Ensure that the content is relevant and useful for the intended users. 👥
+* **Searchability**: Make the documentation easily searchable by including a table of contents, index, and keywords. This helps users quickly find the information they need. 🔍
+* **Feedback and improvement**: Encourage users to provide feedback on the documentation. Use this feedback to continuously improve the quality and usefulness of the documentation. 📈
+
+By following these guidelines, you can create effective technical documentation that is clear, accurate, and user-friendly.

eip-template.md

@@ -115,6 +115,30 @@ No backward compatibility issues found.
 
 Needs discussion.
 
+## Examples and Visuals
+
+### Example 1: Simple Smart Contract
+
+```solidity
+pragma solidity ^0.8.0;
+
+contract SimpleStorage {
+    uint256 public storedData;
+
+    function set(uint256 x) public {
+        storedData = x;
+    }
+
+    function get() public view returns (uint256) {
+        return storedData;
+    }
+}
+```
+
+### Example 2: Visual Representation of a Transaction
+
+![Transaction Flow](../assets/eip-template/transaction-flow.png)
+
 ## Copyright
 
 Copyright and related rights waived via [CC0](../LICENSE.md).

index.html

@@ -14,10 +14,17 @@ <h1 class="page-heading">EIPs
 </h1>
 <p>Ethereum Improvement Proposals (EIPs) describe standards for the Ethereum platform, including core protocol specifications, client APIs, and contract standards. Network upgrades are discussed separately in the <a target="_blank" href="https://github.com/ethereum/pm/">Ethereum Project Management</a> repository.</p>
 
-<h2>Contributing</h2>
+<h2>Table of Contents</h2>
+<ul>
+  <li><a href="#contributing">Contributing</a></li>
+  <li><a href="#eip-status-terms">EIP Status Terms</a></li>
+  <li><a href="#eip-types">EIP Types</a></li>
+</ul>
+
+<h2 id="contributing">Contributing</h2>
 <p>First review <a href="EIPS/eip-1">EIP-1</a>. Then clone the repository and add your EIP to it. There is a <a href="https://github.com/ethereum/EIPs/blob/master/eip-template.md?plain=1">template EIP here</a>. Then submit a Pull Request to Ethereum's <a href="https://github.com/ethereum/EIPs">EIPs repository</a>.</p>
 
-<h2>EIP status terms</h2>
+<h2 id="eip-status-terms">EIP Status Terms</h2>
 <ul>
   <li><strong>Idea</strong> - An idea that is pre-draft. This is not tracked within the EIP Repository.
   <li><strong>Draft</strong> - The first formally tracked stage of an EIP in development. An EIP is merged by an EIP Editor into the EIP repository when properly formatted.</li>
@@ -29,7 +36,7 @@ <h2>EIP status terms</h2>
   <li><strong>Living</strong> - A special status for EIPs that are designed to be continually updated and not reach a state of finality. This includes most notably EIP-1.</li>
 </ul>
 
-<h2>EIP Types</h2>
+<h2 id="eip-types">EIP Types</h2>
 
 <p>EIPs are separated into a number of types, and each has its own list of EIPs.</p>