documentation icon indicating copy to clipboard operation
documentation copied to clipboard

feat/orchid: new documentation structure

Open kbdharun opened this issue 1 year ago • 2 comments

  1. Introduction to Vanilla OS
  2. Structure of Vanilla OS (Images, tools)
  3. Docs about specific tools (manpage)
  4. Full Changelogs for major versions

Excerpts from the recent meeting regarding new docs.

Edit. This is a tracking issue like https://github.com/Vanilla-OS/handbook/issues/104, feel free to add your suggestions related to the new core documentation here.

kbdharun avatar Jun 17 '24 15:06 kbdharun

I think a documentation page/section that defines terms is needed for each part of the system

For example, with vib:

what is:

  • OCI
  • Image
  • Containers / Containerization / Containerized
  • podman (and its relationship with docker, and why you chose podman over docker)

and also

  • Flatpak (including "Sandbox / Sandboxing" the relationship of those term with container)

which is a mainstreamly used software in Linux that could not be clear for the average user

and only THEN, define

  • vib

While also adding why vib uses an image builder which is a feature included in podman

Malix-Labs avatar Jul 11 '24 14:07 Malix-Labs

Also, about VanillaOS directly, I think it would be a good idea to discloses that VanillaOS doesn't run itself in a container.

I've seen someone said that online, so that might be something to clarify

Malix-Labs avatar Jul 11 '24 14:07 Malix-Labs