How ethereum/eips works
Project type and purpose
• This is a static documentation website built with Jekyll. Its sole purpose is to host, validate, and serve the collection of Ethereum Improvement Proposals (EIPs) as static HTML pages on GitHub Pages. Contributors propose and update EIPs as Markdown files; automated bots and validators enforce format and style; Jekyll transforms source files into the published site.
File structure
• Top-level directories:
• EIPS/ – all proposal Markdown files, organized by number.
• _includes/, _layouts/ – Jekyll template fragments and page layouts.
• assets/ – CSS, JSON test vectors, reference implementations, and other per-EIP assets.
• _data/, _config.yml, config/ – site configuration, metadata, linter/CI settings.
• .github/workflows/ – CI/CD definitions (PR validation, auto-merge bots, site build).
• Key config files: Gemfile/Gemfile.lock (Ruby deps), config files for eipw, HTMLProofer, codespell, markdownlint.
README for additional insights
• Build commands (bundle exec jekyll serve), local validator (eipw), CI bots (eip-review-bot), formatting checks (HTMLProofer, markdownlint, codespell).
• Deployment: whenever changes merge, GitHub Pages picks up the generated _site folder and publishes it at https://eips.ethereum.org/.
Main components
a. Content Store
– EIPS Markdown files
– YAML data (statuses.yaml)
– assets (CSS, JSON, PDFs, test vectors)
b. Static Site Generator
– Jekyll engine (Ruby) loading _config.yml, templates, includes, layouts
– Liquid rendering to HTML
c. CI Validation & Automation
– GitHub Actions workflows:
• PR linting/format checks (markdownlint, HTMLProofer, codespell)
• EIP rules enforcement (eipw)
• Auto-merge/eip-review-bot
– Renovate bot (dependency updates)
d. Deployment Platform
– GitHub Pages hosting the generated _site
e. External Services & Stakeholders
– Contributors (via GitHub PRs)
– Ethereum Magicians / Research links (for discussions)
– GitHub (source repo, Actions, Pages)
– Browsers (end users consuming the static site)
Relationships & data-flow
1. Contributor pushes/opens PR → GitHub triggers Actions.
2. CI checks run: eipw, markdownlint, codespell, HTMLProofer → report pass/fail.
3. auto-review-bot labels or auto-merges approved PRs.
4. On merge to main, GitHub Pages build (or prebuilt by CI) publishes HTML.
5. End user’s browser fetches HTML/CSS assets from GitHub Pages.
Architectural patterns & design principles
• Pipeline pattern: source → validation → build → deploy.
• Template/Content separation: content in Markdown + data in YAML; presentation in Liquid templates.
• Event-driven CI: pull_request and push events trigger validation and deployment.
• Infrastructure-as-code: workflows and config under version control.