Skip to content

cosmos/docs

Repository files navigation

Cosmos EVM Documentation

Documentation for Cosmos EVM, a framework for running Ethereum Virtual Machine (EVM) on Cosmos SDK chains with IBC support.

Project Structure

  • docs/next/ - Active development documentation
  • docs/v0.4.x/ - Frozen version documentation
  • scripts/versioning/ - Documentation versioning tools (see README)
  • snippets/ - Shared React components

Contributing

Fork the repository

  • Click “Fork” in the GitHub UI to create your own copy.

Clone your fork

   git clone https://github.com/<your-username>/cosmos-docs.git
   cd cosmos-docs

Create a branch

   git checkout -b my-feature

Make your changes

  • Edit or add files under docs/next/ as needed.
  • Follow existing file structure and naming conventions.
  • Ensure Markdown is valid and links resolve.

Local testing & validation

# Start a live-reload preview
npx mint dev

# Check for broken internal links
npx mint broken-links

Commit and push

   git add .
   git commit -m "Brief description of your change"
   git push origin my-feature

Open a Pull Request

  • On GitHub, navigate to your fork.
  • Click “Compare & pull request.”
  • Provide a concise title and description.
  • Submit the PR for review.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7