Skip to content

Commit 9dab9fc

Browse files
committed
docs: add content to Developer’s Guide (#3792)
1 parent cbc0895 commit 9dab9fc

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

website/content/en/docs/dev/_index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,24 @@
22
title: Developers' guide
33
weight: 500
44
---
5+
6+
Welcome to the Lima Developer Guide!
7+
8+
If you're new to the project and want to contribute, you're in the right place. Lima is an open-source tool that helps you run Linux virtual machines on macOS with ease.
9+
10+
Here are some helpful resources to get started:
11+
12+
## 📌 Quick Start for Contributors
13+
14+
- **Explore the codebase**: Use [DeepWiki's Lima page](https://deepwiki.com/lima-vm/lima) to understand the structure and find references easily.
15+
- **Check the project structure**: Key directories include `cmd/`, `pkg/`, and `website/`.
16+
- **Follow the contributing guide**: Read [`CONTRIBUTING.md`](https://github.com/lima-vm/lima/blob/master/CONTRIBUTING.md) for setup instructions.
17+
- **Join the discussion**: Engage with the community via GitHub Issues or Discussions.
18+
19+
## 🧠 Tips for First-Time Contributors
20+
21+
- Start small: Fix typos, update docs, or improve clarity in comments.
22+
- Don’t be afraid to ask questions.
23+
- Use `make` to build the project or run tests if you're exploring the CLI side.
24+
25+
We’re glad you’re here — every contribution counts!

0 commit comments

Comments
 (0)