Improvement to developer's guide

[rochaporto]

Description

As part of the DD for Lima's incubation application, we identified that the developer's guide could be improved.

Currently this page contains relevant information but focuses on internal structures and configuration options and running the test suite:
https://lima-vm.io/docs/dev/

The project could consider a more friendly developer guide to ease newcomers wanting to contribute to the project.

[afbjorklund]

We could use a more detailed User's Guide as well, I started on a framework for it but didn't fill it in much with info.

https://github.com/afbjorklund/lima-man

[jandubois]

I’m interested in contributing to this and was wondering if the issue is still open. If so, could I please be assigned to it?

Thank you for your offer! I've assigned the issue to you.

If you want to make larger structural changes to the docs, then please have a discussion about it first. But if you are just going to improve the content while staying with the basic structure, then go right ahead!

One thing that is currently a bit hidden is the link to https://deepwiki.com/lima-vm/lima (it is just a badge on the README.md). It contains AI generated documentation of the whole repo and is updated on a weekly basis.

This resource should be pointed at in the developer docs because it is a good way to learn about the project and architecture. The deepwiki page even has an agent, so you can ask questions about parts you don't understand (or want to learn more about).

[ijayhub]

Thanks for the clarification!
I’ll stick to improving the content within the current structure and avoid large structural changes for now.

[AkihiroSuda]

Currently this page contains relevant information but focuses on internal structures and configuration options and running the test suite:
https://lima-vm.io/docs/dev/

The project could consider a more friendly developer guide to ease newcomers wanting to contribute to the project.

Can we just link add a link to https://lima-vm.io/docs/community/contributing/ in https://lima-vm.io/docs/dev/ ?