webdevops / vagrant-docker-vm

:computer: Development Vagrant VM with Docker, Samba and Mail sandbox (customizable)
https://webdevops.io/projects/vagrant-docker-vm/
MIT License
87 stars 28 forks source link

Documentation Structure should be improved #21

Closed PanadeEdu closed 9 years ago

PanadeEdu commented 9 years ago

Problem Description: The current Documentation provides Informations in a One Page Design. This could be Improved to extend the Repository with a Documentation Folder which Provides Sub-Pages for each Topic.

Possible Solution: Extract the main Parts from Documentation and split them in seperate Files such as (only an Example):

Like the SRP (Single Responsibility Principle), it improves readability if one Page only contains one responsibility. The main Page should only contain:

mblaschke commented 9 years ago

Improved some documentation 4f31051dc3404fdd797c2b242f60b9654dba1f83