https://github.com/starknet-io/starknet-docs
Starknet's developer documentation
https://github.com/starknet-io/starknet-docs
contributions-welcome documentation starknet
Last synced: 5 months ago
JSON representation
Starknet's developer documentation
- Host: GitHub
- URL: https://github.com/starknet-io/starknet-docs
- Owner: starknet-io
- Created: 2022-01-24T10:18:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-10T12:42:08.000Z (6 months ago)
- Last Synced: 2025-12-10T12:46:47.863Z (6 months ago)
- Topics: contributions-welcome, documentation, starknet
- Language: MDX
- Homepage: https://docs.starknet.io
- Size: 174 MB
- Stars: 164
- Watchers: 8
- Forks: 232
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌟 The Starknet Docs Repository
[](https://mintlify.com)
[](README.md#-contributing)
[👀 View Website](https://docs.starknet.io) • [🐛 Report Bug](https://github.com/starknet-io/starknet-docs/issues) • [💡 Request Feature](https://github.com/starknet-io/starknet-docs/issues)
## 📖 About
Welcome to the Starknet Docs repository!
The Starknet Docs is the official documentation hub for Starknet, providing comprehensive guides, references, and resources for all developers, validators, and users of Starknet.
## 🛠️ Setup
### Prerequisites
- [Node.js](https://nodejs.org/) (v18 or higher)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Local Development
1. **Install the Mintlify CLI**
```bash
npm install -g mint
```
2. **Clone the repository**
```bash
git clone https://github.com/starknet-io/starknet-docs.git
cd starknet-docs
```
3. **Start the development server**
```bash
mint dev
```
4. **Open your browser**
Navigate to `http://localhost:3000` to see the documentation locally.
### Troubleshooting
| Issue | Solution |
|-------|----------|
| `mint dev` not running | Run `npm install -g mint` to reinstall dependencies |
| Page loads as 404 | Ensure you're in the folder containing `docs.json` |
| Port already in use | Use `mint dev --port 3001` to specify a different port |
## 🚀 Deployment
Documentation is automatically deployed to production when changes are pushed to the main branch. The deployment is handled by Mintlify's GitHub integration.
### Deployment Process
1. **Push** to main branch
2. **Mintlify** automatically builds and deploys
3. **Changes** are live at [docs.starknet.io](https://docs.starknet.io)
## 🤝 Contributing
We welcome contributions from the community! Here's how you can help:
### Content Contributions
1. **Fork** the repository
2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
3. **Make** your changes
4. **Test** locally with `mint dev`
5. **Commit** your changes (`git commit -m 'Add amazing feature'`)
6. **Push** to the branch (`git push origin feature/amazing-feature`)
7. **Open** a Pull Request
### Reporting Issues
Found a bug or have a suggestion? Please [open an issue](https://github.com/starknet-io/starknet-docs/issues) with:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Screenshots (if applicable)
### Content Guidelines
- Use clear, concise language
- Include code examples where appropriate
- Follow the existing documentation structure
- Test all code examples
- Add images to enhance understanding