From 9dab9fc485a032cb33aa61c98d74dcec3721680f Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Thu, 7 Aug 2025 12:44:31 +0100 Subject: [PATCH 1/6] =?UTF-8?q?docs:=20add=20content=20to=20Developer?= =?UTF-8?q?=E2=80=99s=20Guide=20(#3792)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/content/en/docs/dev/_index.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index bbe1aa0978e..2cd9e6dcfff 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -2,3 +2,24 @@ title: Developers' guide weight: 500 --- + +Welcome to the Lima Developer Guide! + +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. + +Here are some helpful resources to get started: + +## 📌 Quick Start for Contributors + +- **Explore the codebase**: Use [DeepWiki's Lima page](https://deepwiki.com/lima-vm/lima) to understand the structure and find references easily. +- **Check the project structure**: Key directories include `cmd/`, `pkg/`, and `website/`. +- **Follow the contributing guide**: Read [`CONTRIBUTING.md`](https://github.com/lima-vm/lima/blob/master/CONTRIBUTING.md) for setup instructions. +- **Join the discussion**: Engage with the community via GitHub Issues or Discussions. + +## 🧠 Tips for First-Time Contributors + +- Start small: Fix typos, update docs, or improve clarity in comments. +- Don’t be afraid to ask questions. +- Use `make` to build the project or run tests if you're exploring the CLI side. + +We’re glad you’re here — every contribution counts! From 7da6a6c4838a47a55d924f96dc853ca8752d3ad1 Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Thu, 7 Aug 2025 13:56:43 +0100 Subject: [PATCH 2/6] =?UTF-8?q?docs:=20add=20content=20to=20Developer?= =?UTF-8?q?=E2=80=99s=20Guide=20(#3792)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/content/en/docs/dev/_index.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index 2cd9e6dcfff..9263844c357 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -5,21 +5,22 @@ weight: 500 Welcome to the Lima Developer Guide! -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. +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. -Here are some helpful resources to get started: +Here’s how you can get started: ## 📌 Quick Start for Contributors -- **Explore the codebase**: Use [DeepWiki's Lima page](https://deepwiki.com/lima-vm/lima) to understand the structure and find references easily. -- **Check the project structure**: Key directories include `cmd/`, `pkg/`, and `website/`. -- **Follow the contributing guide**: Read [`CONTRIBUTING.md`](https://github.com/lima-vm/lima/blob/master/CONTRIBUTING.md) for setup instructions. -- **Join the discussion**: Engage with the community via GitHub Issues or Discussions. +- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to see how things are set up. +- **Know the main folders**: Look inside `cmd/`, `pkg/`, and `website/`. These are important parts of the project. +- **Read the guide**: Follow the steps in [`CONTRIBUTING.md`](https://github.com/lima-vm/.github/blob/main/CONTRIBUTING.md) to set up everything. +- **Talk with others by joining the community**: You can ask questions or share your ideas on GitHub Issues or Discussions. ## 🧠 Tips for First-Time Contributors -- Start small: Fix typos, update docs, or improve clarity in comments. -- Don’t be afraid to ask questions. -- Use `make` to build the project or run tests if you're exploring the CLI side. +- Start with small things: fix typos, improve docs, or make comments in code easier to understand. +- Don’t worry if you’re not sure—just ask. +- Use `make` to test or build the project if you're working with the command line. + +We’re happy you’re here. Every little bit of contribution counts! -We’re glad you’re here — every contribution counts! From 35c91d3da73139ad85e0485de9fbe77419a0821c Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Thu, 7 Aug 2025 14:51:02 +0100 Subject: [PATCH 3/6] docs: improve Developers' guide with clear getting started steps Signed-off-by: Ijeoma Igboagu --- website/content/en/docs/dev/_index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index 9263844c357..e904b9f0cd3 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -5,22 +5,24 @@ weight: 500 Welcome to the Lima Developer Guide! -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. +Lima is a free tool that helps you run Linux virtual machines, mostly on macOS and Linux. -Here’s how you can get started: +Here’s how to get started: ## 📌 Quick Start for Contributors -- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to see how things are set up. -- **Know the main folders**: Look inside `cmd/`, `pkg/`, and `website/`. These are important parts of the project. +- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to understand how things are set up. +- **Know the main folders**: + - `cmd/` and `pkg/` — contain the main source code. + - `website/` — contains the documentation website ([lima-vm.io](https://lima-vm.io)). - **Read the guide**: Follow the steps in [`CONTRIBUTING.md`](https://github.com/lima-vm/.github/blob/main/CONTRIBUTING.md) to set up everything. -- **Talk with others by joining the community**: You can ask questions or share your ideas on GitHub Issues or Discussions. +- **Join the community**: You can ask questions or share ideas through GitHub Issues or Discussions. ## 🧠 Tips for First-Time Contributors -- Start with small things: fix typos, improve docs, or make comments in code easier to understand. -- Don’t worry if you’re not sure—just ask. -- Use `make` to test or build the project if you're working with the command line. +- Start small: fix typos, improve docs, or make code comments easier to understand. +- Don’t be afraid to ask questions. +- Use `make` to build or test the project from the command line. We’re happy you’re here. Every little bit of contribution counts! From 6c2b0b56371f0ab79ef21e08ffb0fda64d4a419e Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Fri, 8 Aug 2025 15:08:04 +0100 Subject: [PATCH 4/6] =?UTF-8?q?docs:=20add=20content=20to=20Developer?= =?UTF-8?q?=E2=80=99s=20Guide=20(#3792)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ijeoma Igboagu --- website/content/en/docs/dev/_index.md | 33 ++++++++------------------- 1 file changed, 10 insertions(+), 23 deletions(-) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index e904b9f0cd3..dfa7367d9a8 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -1,28 +1,15 @@ ---- -title: Developers' guide -weight: 500 ---- +--- Title: Developer's Guide -Welcome to the Lima Developer Guide! + Weight: 500. -Lima is a free tool that helps you run Linux virtual machines, mostly on macOS and Linux. + Lima allows you to run Linux virtual machines on both macOS and Linux. -Here’s how to get started: + ## Quick Start for Contributors -## 📌 Quick Start for Contributors - -- **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to understand how things are set up. -- **Know the main folders**: - - `cmd/` and `pkg/` — contain the main source code. - - `website/` — contains the documentation website ([lima-vm.io](https://lima-vm.io)). -- **Read the guide**: Follow the steps in [`CONTRIBUTING.md`](https://github.com/lima-vm/.github/blob/main/CONTRIBUTING.md) to set up everything. -- **Join the community**: You can ask questions or share ideas through GitHub Issues or Discussions. - -## 🧠 Tips for First-Time Contributors - -- Start small: fix typos, improve docs, or make code comments easier to understand. -- Don’t be afraid to ask questions. -- Use `make` to build or test the project from the command line. - -We’re happy you’re here. Every little bit of contribution counts! + - For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima). + - The main source code is located in the 'cmd/' and 'pkg/' directories. + - If you wish to contribute, please see [CONTRIBUTING.md](../../../../.github/CONTRIBUTING.md). + - Have any questions or ideas? To share them, create a GitHub issue or a discussion. + - Run the'make help' command in your terminal to see what other test commands you can use. + - For additional information on the documentation, please visit ([lima-vm.io](https://lima-vm.io). From 686fa1b3b9c95b9b8e9cc3e47de72c7a29c01326 Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Fri, 8 Aug 2025 15:32:26 +0100 Subject: [PATCH 5/6] =?UTF-8?q?docs:=20add=20content=20to=20Developer?= =?UTF-8?q?=E2=80=99s=20Guide=20(#3792)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ijeoma Igboagu --- website/content/en/docs/dev/_index.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index dfa7367d9a8..0f6253d6231 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -1,10 +1,12 @@ ---- Title: Developer's Guide +--- +Title: Developer's Guide - Weight: 500. +Weight: 500. +--- - Lima allows you to run Linux virtual machines on both macOS and Linux. +Lima allows you to run Linux virtual machines on both macOS and Linux. - ## Quick Start for Contributors +## Quick Start for Contributors - For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima). - The main source code is located in the 'cmd/' and 'pkg/' directories. From d306c7f6622ef380e299b16da2cc6e2070d9eb78 Mon Sep 17 00:00:00 2001 From: Ijeoma Igboagu Date: Fri, 8 Aug 2025 20:38:13 +0100 Subject: [PATCH 6/6] docs: improve developer guide with clearer instructions Signed-off-by: Ijeoma Igboagu --- website/content/en/docs/dev/_index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/content/en/docs/dev/_index.md b/website/content/en/docs/dev/_index.md index 0f6253d6231..062e8c8afb6 100644 --- a/website/content/en/docs/dev/_index.md +++ b/website/content/en/docs/dev/_index.md @@ -1,17 +1,17 @@ ---- + +--- Title: Developer's Guide -Weight: 500. +Weight: 500 --- -Lima allows you to run Linux virtual machines on both macOS and Linux. +Lima is an open-source tool that allows you to run Linux virtual machines on both macOS and Linux. ## Quick Start for Contributors - - For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima). + - For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com) - The main source code is located in the 'cmd/' and 'pkg/' directories. - If you wish to contribute, please see [CONTRIBUTING.md](../../../../.github/CONTRIBUTING.md). - Have any questions or ideas? To share them, create a GitHub issue or a discussion. - Run the'make help' command in your terminal to see what other test commands you can use. - - For additional information on the documentation, please visit ([lima-vm.io](https://lima-vm.io). - + - For additional information on the documentation, please visit ([lima-vm.io](https://lima-vm.io)