🌟 The Starknet Docs Repository

👀 View Website • 🐛 Report Bug • 💡 Request Feature

📖 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 (v18 or higher)
• npm or yarn

Local Development

1. Install the Mintlify CLI

   npm install -g mint

2. Clone the repository

   git clone https://github.com/starknet-io/starknet-docs.git
   cd starknet-docs

3. Start the development server

   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

🤝 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 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