Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat/orchid: new documentation structure #112

Open
kbdharun opened this issue Jun 17, 2024 · 2 comments
Open

feat/orchid: new documentation structure #112

kbdharun opened this issue Jun 17, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@kbdharun
Copy link
Member

kbdharun commented Jun 17, 2024

  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 Vanilla-OS/handbook#104, feel free to add your suggestions related to the new core documentation here.

@kbdharun kbdharun added the documentation Improvements or additions to documentation label Jun 17, 2024
@kbdharun kbdharun self-assigned this Jun 17, 2024
@kbdharun kbdharun moved this to In Progress in Documentation Progress Jun 17, 2024
@kbdharun kbdharun added this to the orchid-stable milestone Jun 17, 2024
@kbdharun kbdharun changed the title Orchid: New documentation syntax Orchid: New documentation structure Jun 17, 2024
@kbdharun kbdharun changed the title Orchid: New documentation structure feat/orchid: New documentation structure Jun 17, 2024
@kbdharun kbdharun changed the title feat/orchid: New documentation structure feat/orchid: new documentation structure Jun 17, 2024
@Malix-Labs
Copy link

Malix-Labs commented Jul 11, 2024

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

No branches or pull requests

2 participants