Skip to content

Commit a2106d5

Browse files
committed
docs: create README.md
1 parent b375b41 commit a2106d5

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# d-sys.wiki
2+
3+
[![GitHub license](https://img.shields.io/github/license/captradeoff/d-sys-wiki)](https://github.com/captradeoff/d-sys-wiki/blob/master/LICENSE)
4+
5+
**d-sys.wiki** is your comprehensive resource for all things related to distributed systems. This repository contains the source code for the [d-sys.wiki](https://d-sys.wiki) website, which provides accessible explanations, resources, and tools for understanding, architecting, and building distributed systems.
6+
7+
## πŸ“š Content
8+
9+
The wiki includes:
10+
11+
- Simple, casual explanations of distributed systems concepts
12+
- Early access to pre-prints on distributed systems research
13+
- Case studies with reproducible research and code examples
14+
- Information about open source projects, software, and tools
15+
- Curated links to top books and talks in the field
16+
- And more!
17+
18+
## πŸš€ Getting Started
19+
20+
### For Readers
21+
22+
Visit [d-sys.wiki](https://d-sys.wiki) to access the published content.
23+
24+
### For Contributors and Local Development
25+
26+
This wiki is built using [MkDocs](https://www.mkdocs.org/) with the terminal theme.
27+
28+
#### Prerequisites
29+
30+
- Python 3.x
31+
- pip (Python package manager)
32+
33+
#### Local Setup
34+
35+
1. Clone the repository:
36+
```bash
37+
git clone https://github.com/captradeoff/d-sys-wiki.git
38+
cd d-sys-wiki
39+
```
40+
41+
2. Install MkDocs and required plugins:
42+
```bash
43+
pip install mkdocs
44+
pip install mkdocs-terminal
45+
pip install mkdocs-git-revision-date-plugin
46+
pip install mkdocs-spellcheck-plugin
47+
```
48+
49+
3. Run the development server:
50+
```bash
51+
mkdocs serve
52+
```
53+
54+
4. Open your browser and navigate to `http://localhost:8000` to see the local version of the wiki.
55+
56+
## πŸ“ Contributing
57+
58+
Contributions to d-sys.wiki are welcome and appreciated! Here's how you can contribute:
59+
60+
1. **Report Issues**: If you find errors or have suggestions, please [open an issue](https://github.com/captradeoff/d-sys-wiki/issues).
61+
62+
2. **Submit Content**: To add or modify content:
63+
- Fork the repository
64+
- Create a new branch for your changes
65+
- Make your changes to the relevant Markdown files in the `docs/` directory
66+
- Submit a pull request
67+
68+
3. **Content Guidelines**:
69+
- Write in a clear, accessible style
70+
- Include examples where appropriate
71+
- Cite sources for technical information
72+
- Follow the existing formatting conventions
73+
74+
## πŸ—οΈ Project Structure
75+
76+
```
77+
d-sys-wiki/
78+
β”œβ”€β”€ docs/ # Documentation source files
79+
β”‚ β”œβ”€β”€ index.md # Home page
80+
β”‚ β”œβ”€β”€ about/ # About section
81+
β”‚ β”œβ”€β”€ fundamentals/ # Fundamental concepts
82+
β”‚ └── img/ # Images and resources
83+
β”œβ”€β”€ mkdocs.yml # MkDocs configuration
84+
β”œβ”€β”€ CNAME # Custom domain configuration
85+
└── LICENSE # MIT License
86+
```
87+
88+
## πŸ“„ License
89+
90+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
91+
92+
## πŸ“¬ Contact
93+
94+
- GitHub: [@captradeoff](https://github.com/captradeoff)
95+
- Twitter/X: [@captradeoff](https://x.com/captradeoff)

0 commit comments

Comments
Β (0)