Skip to content

Commit 9736ff0

Browse files
committed
mintlify migration
1 parent 33af2b4 commit 9736ff0

File tree

1,044 files changed

+45822
-10729
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,044 files changed

+45822
-10729
lines changed

β€Ž.DS_Storeβ€Ž

6 KB
Binary file not shown.

β€ŽCI/Jenkinsfileβ€Ž

Lines changed: 0 additions & 151 deletions
This file was deleted.

β€ŽCI/scripts/comment_pr.pyβ€Ž

Lines changed: 0 additions & 46 deletions
This file was deleted.

β€ŽREADME.adocβ€Ž

Lines changed: 0 additions & 57 deletions
This file was deleted.

β€ŽREADME.mdβ€Ž

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# 🌟 The Starknet Docs Repository
2+
3+
<div align="center">
4+
5+
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fdocs.starknet.io&style=for-the-badge&logo=firefox&logoColor=white)](https://docs.starknet.io)
6+
[![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE)
7+
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?style=for-the-badge)](CONTRIBUTING.md)
8+
[![Built with Mintlify](https://img.shields.io/badge/built%20with-mintlify-00D4AA?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEyIDJMMTMuMDkgOC4yNkwyMCA5TDEzLjA5IDE1Ljc0TDEyIDIyTDEwLjkxIDE1Ljc0TDQgOUwxMC45MSA4LjI2TDEyIDJaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K)](https://mintlify.com)
9+
10+
[πŸš€ View Documentation](https://docs.starknet.io) β€’ [πŸ› Report Bug](https://github.com/starknet-io/starknet-docs/issues) β€’ [πŸ’‘ Request Feature](https://github.com/starknet-io/starknet-docs/issues)
11+
12+
</div>
13+
14+
---
15+
16+
## πŸ“– About
17+
18+
This repository contains the official documentation for **Starknet**, a permissionless decentralized validity rollup (often referred to as a "zk-rollup") that operates as an L2 network over Ethereum. Our documentation provides comprehensive guides, references, and resources for developers, validators, and users.
19+
20+
### 🎯 What You'll Find Here
21+
22+
- **πŸ—οΈ Build**: Find everything you need to build Starknet's next killer app
23+
- **πŸ›‘οΈ Secure**: Help secure Starknet by running a node and becoming a validator
24+
- **πŸŽ“ Learn**: Dive into Starknet's architecture, S-two prover, and more
25+
26+
---
27+
28+
## 🌱 Getting Started
29+
30+
### Prerequisites
31+
32+
- [Node.js](https://nodejs.org/) (v18 or higher)
33+
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
34+
35+
### πŸ› οΈ Local Development
36+
37+
1. **Install the Mintlify CLI**
38+
```bash
39+
npm install -g mint
40+
```
41+
42+
2. **Clone the repository**
43+
```bash
44+
git clone https://github.com/starknet-io/starknet-docs.git
45+
cd starknet-docs
46+
```
47+
48+
3. **Start the development server**
49+
```bash
50+
mint dev
51+
```
52+
53+
4. **Open your browser**
54+
Navigate to `http://localhost:3000` to see the documentation locally.
55+
56+
### πŸ”§ Troubleshooting
57+
58+
| Issue | Solution |
59+
|-------|----------|
60+
| `mint dev` not running | Run `npm install -g mint` to reinstall dependencies |
61+
| Page loads as 404 | Ensure you're in the folder containing `docs.json` |
62+
| Port already in use | Use `mint dev --port 3001` to specify a different port |
63+
64+
---
65+
66+
## πŸš€ Deployment
67+
68+
Documentation is automatically deployed to production when changes are pushed to the main branch. The deployment is handled by Mintlify's GitHub integration.
69+
70+
### Deployment Process
71+
72+
1. **Push** to main branch
73+
2. **Mintlify** automatically builds and deploys
74+
3. **Changes** are live at [docs.starknet.io](https://docs.starknet.io)
75+
76+
---
77+
78+
## 🀝 Contributing
79+
80+
We welcome contributions from the community! Here's how you can help:
81+
82+
### πŸ“ Content Contributions
83+
84+
1. **Fork** the repository
85+
2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
86+
3. **Make** your changes
87+
4. **Test** locally with `mint dev`
88+
5. **Commit** your changes (`git commit -m 'Add amazing feature'`)
89+
6. **Push** to the branch (`git push origin feature/amazing-feature`)
90+
7. **Open** a Pull Request
91+
92+
### πŸ› Reporting Issues
93+
94+
Found a bug or have a suggestion? Please [open an issue](https://github.com/starknet-io/starknet-docs/issues) with:
95+
96+
- Clear description of the problem
97+
- Steps to reproduce
98+
- Expected vs actual behavior
99+
- Screenshots (if applicable)
100+
101+
### πŸ“‹ Content Guidelines
102+
103+
- Use clear, concise language
104+
- Include code examples where appropriate
105+
- Follow the existing documentation structure
106+
- Test all code examples
107+
- Add images to enhance understanding
108+
109+
---
110+
111+
## πŸ“„ License
112+
113+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
114+
115+
---
116+
117+
<div align="center">
118+
119+
**Made with ❀️ by the Starknet community**
120+
121+
[⭐ Star this repo](https://github.com/starknet-io/starknet-docs) β€’ [🐦 Follow us](https://twitter.com/Starknet) β€’ [πŸ’¬ Join Discord](https://discord.gg/starknet-community)
122+
123+
</div>

β€Ž_typos.tomlβ€Ž

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
Β (0)