https://github.com/eth-infinitism/aa-mkdocs
A community-curated mk-docs on ERC-4337 and Account Abstraction — covering specs, tools, infrastructure, and ecosystem initiatives
https://github.com/eth-infinitism/aa-mkdocs
account-abstraction erc4337 ethereum
Last synced: 8 months ago
JSON representation
A community-curated mk-docs on ERC-4337 and Account Abstraction — covering specs, tools, infrastructure, and ecosystem initiatives
- Host: GitHub
- URL: https://github.com/eth-infinitism/aa-mkdocs
- Owner: eth-infinitism
- License: mit
- Created: 2025-07-10T11:31:26.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-09-21T11:14:10.000Z (9 months ago)
- Last Synced: 2025-09-21T13:08:49.389Z (9 months ago)
- Topics: account-abstraction, erc4337, ethereum
- Language: Python
- Homepage: https://docs.erc4337.io
- Size: 3.74 MB
- Stars: 11
- Watchers: 1
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ERC-4337 Documentation
This repository contains the official documentation for ERC-4337 (Account Abstraction).
## 🚀 Quick Start
### Local Development
1. **Clone the repository:**
```bash
git clone https://github.com/eth-infinitism/aa-mkdocs.git
cd aa-mkdocs
```
2. **Set up Python virtual environment:**
```bash
python3 -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
```
3. **Install dependencies:**
```bash
pip install -r requirements.txt
```
4. **Serve locally:**
```bash
mkdocs serve
```
Open http://127.0.0.1:8000 in your browser.
### Building
To build the static site:
```bash
mkdocs build
```
The built site will be in the `site/` directory.
## 🏗️ Build & Deploy
This documentation is automatically built and deployed using:
- **Cloudflare Pages** for hosting
- **GitHub Actions** for CI/CD
- **MkDocs Material** for the documentation framework
### Cloudflare Pages Settings
- **Build command:** `pip install -r requirements.txt && mkdocs build`
- **Output directory:** `site`
- **Python version:** 3.11
- **PR Previews:** Enabled (automatic preview deployments for pull requests)
### CI/CD
The repository includes GitHub Actions workflow (`.github/workflows/mkdocs-ci.yml`) that:
- Runs on every pull request to `main`
- Installs dependencies
- Builds the documentation with strict mode
- Blocks PRs if build fails
## 🤝 Contributing
### Development Workflow
1. **Fork the repository** and create a feature branch
2. **Make your changes** to the documentation
3. **Test locally** with `mkdocs serve`
4. **Create a pull request** - this will trigger:
- CI build validation
- Cloudflare Pages preview deployment
5. **Review and merge** - changes will be automatically deployed to production
### Guidelines
- **No web editor** - all changes must be made via pull requests
- **Test locally** before submitting PRs
- **Follow Markdown best practices**
- **Update navigation** in `mkdocs.yml` if adding new sections
- **Use descriptive commit messages**
## 🔗 Links
- **Production site:** https://docs.erc4337.io
- **Repository:** https://github.com/eth-infinitism/aa-mkdocs
- **Issues:** https://github.com/eth-infinitism/aa-mkdocs/issues
## 🛠️ Technology Stack
- **MkDocs** - Static site generator
- **Material for MkDocs** - Theme and features
- **Python 3.11** - Runtime environment
- **Cloudflare Pages** - Hosting and CDN
- **GitHub Actions** - CI/CD pipeline
---
[](https://github.com/eth-infinitism/aa-mkdocs/actions)
# Trigger Pages deployment