https://github.com/primev/mev-commit-docs
Open Source technical documentation repository for mev-commit
https://github.com/primev/mev-commit-docs
documentation ethereum mev mev-commit primev
Last synced: 5 months ago
JSON representation
Open Source technical documentation repository for mev-commit
- Host: GitHub
- URL: https://github.com/primev/mev-commit-docs
- Owner: primev
- License: other
- Created: 2024-02-05T17:03:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-11T20:43:48.000Z (6 months ago)
- Last Synced: 2025-12-13T01:20:10.650Z (6 months ago)
- Topics: documentation, ethereum, mev, mev-commit, primev
- Language: MDX
- Homepage: https://docs.primev.xyz/
- Size: 22.4 MB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This is the open source documentation repository for [mev-commit](https://github.com/primev/mev-commit).
# What is mev-commit?
mev-commit is P2P software that creates a network of execution providers and bidders. Bidders can broadcast bids receive commitments from providers. A high throughput POA EVM chain settles the bids at the end of a block slot.
# Contribution Guidelines
This repository contains the source code for our documentation website. If you'd like to contribute, please follow these guidelines:
1. Fork the repository and create a new branch from the `main` branch.
2. Make your changes to the markdown files.
3. If you're creating a new file, edit the `docs.json` file to make it appear on the sidebar.
4. Submit a pull request to the `main` branch.
## Standards and conventions
### Links
- Ensure all links that reference the documentation use an absolute path starting with version number. For example, to reference fund node page, you do as follows: `[fund node](/v0.7.0/get-started/bidders/fund-node)`.
### New Files
- Ensure all files are in lowercase.
- Ensure all files are using kebab-case. For example, the kebab-case version of "My First Preconf" is "my-first-preconf.mdx".
Run `mintlify dev` to test the changes locally and `mintlify broken-links` to confirm no new broken links were introduced.