ERC-8004

Appearance

Quick Start Guide ​

This guide will help you get started with the ERC-8004 documentation repository.

Prerequisites ​

  • Node.js (v18 or higher)
  • npm (v9 or higher)
  • Git

Setup ​

  1. Clone the repository

    bash
    git clone https://github.com/alt-research/8004scan-best-practices.git
cd 8004scan-best-practices

  2. Install dependencies

    bash
    make install

    This will install:

    • VitePress (documentation framework)
    • npm packages (Prettier, markdownlint)

Development Workflow ​

Preview Documentation Locally ​

bash
make dev

The development server will start at http://localhost:5173. Changes will hot-reload automatically.

Format Markdown Files ​

bash
# Auto-format all Markdown files
make format

# Check formatting without modifying
make format-check

Lint Markdown Files ​

bash
# Check for linting issues
make lint

# Auto-fix linting issues
make lint-fix

Build Static Site ​

bash
make build

The built site will be in the .vitepress/dist/ directory.

Preview Built Site ​

After building, you can preview the production build:

bash
make preview

The preview server will start at http://localhost:4173.

Before committing changes:

bash
# 1. Format and lint
make format && make lint-fix

# 2. Preview changes
make dev

# 3. Build to ensure no errors
make build

# 4. Commit changes
git add .
git commit -m "Your commit message"

File Structure ​

bash
.
├── .vitepress/               # VitePress configuration
│   ├── config.mts            # Site configuration
│   └── theme/                # Custom theme
├── docs/                     # ERC-8004 standard documentation
│   ├── 00-CONVENTIONS.md     # Naming conventions
│   ├── 01-*.md               # Core standards
│   ├── extensions/           # Optional extensions
│   ├── implementation/       # Implementation guides
│   └── reference/            # Reference materials
├── index.md                  # Homepage (VitePress)
├── README.md                 # Documentation overview
└── package.json              # Dependencies and scripts

Available Commands ​

Run make help to see all available commands:

bash
make help

Getting Help ​

  • Read CONTRIBUTING.md for detailed guidelines
  • Check README.md for documentation overview
  • Open an issue for questions or problems

Next Steps ​

  1. Explore the documentation
  2. Review contribution guidelines
  3. Start with Conventions

Happy documenting!