Skip to content

[Request]: Structured documentation for the container commands #375

@Daniel-Nashed

Description

@Daniel-Nashed

Feature or enhancement request details

Hi team!

I was looking for information about adding more memory and CPU information and it turned out it be in the howto section.
IMHO a project like this needs a bit more structured documentation.

This information can still be listed in a howto. But all parameters should be documented in reference material.

We had to learn structuring repositories and add GitHub pages to better structure the information in our projects.
A good structured documentation will pay back from my experience in other projects.

Idea

  • reference material --> a full reference of all commands
  • howto --> quick information to perform a specific task
  • tutorials --> more comprehensive to learn how functionality belongs together

The documentation page referenced in the project is more for an API documentation.
It would make sense to have a reference for the container command, too.
This could have the same style.

Reference

Here is a good reference for a documentation structure and what it is used for.
Maybe you find it useful. It helped me a lot in other projects.

https://docs.divio.com/documentation-system/

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions