Skip to content

Commit 3c03571

Browse files
committed
docs: improve Developers' guide with clear getting started steps
1 parent 7da6a6c commit 3c03571

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,24 @@ weight: 500
55

66
Welcome to the Lima Developer Guide!
77

8-
If you’re new and want to help with Lima, you’re in the right place. Lima is a free tool that helps you run Linux virtual machines on macOS.
8+
Lima is a free tool that helps you run Linux virtual machines, mostly on macOS and Linux.
99

10-
Here’s how you can get started:
10+
Here’s how to get started:
1111

1212
## 📌 Quick Start for Contributors
1313

14-
- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to see how things are set up.
15-
- **Know the main folders**: Look inside `cmd/`, `pkg/`, and `website/`. These are important parts of the project.
14+
- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to understand how things are set up.
15+
- **Know the main folders**:
16+
- `cmd/` and `pkg/` — contain the main source code.
17+
- `website/` — contains the documentation website ([lima-vm.io](https://lima-vm.io)).
1618
- **Read the guide**: Follow the steps in [`CONTRIBUTING.md`](https://github.com/lima-vm/.github/blob/main/CONTRIBUTING.md) to set up everything.
17-
- **Talk with others by joining the community**: You can ask questions or share your ideas on GitHub Issues or Discussions.
19+
- **Join the community**: You can ask questions or share ideas through GitHub Issues or Discussions.
1820

1921
## 🧠 Tips for First-Time Contributors
2022

21-
- Start with small things: fix typos, improve docs, or make comments in code easier to understand.
22-
- Don’t worry if you’re not sure—just ask.
23-
- Use `make` to test or build the project if you're working with the command line.
23+
- Start small: fix typos, improve docs, or make code comments easier to understand.
24+
- Don’t be afraid to ask questions.
25+
- Use `make` to build or test the project from the command line.
2426

2527
We’re happy you’re here. Every little bit of contribution counts!
2628

0 commit comments

Comments
 (0)