Consider splitting README into multiple docs

kartoza / docker-postgis

Dockerfile for postgis

GNU General Public License v2.0

657 stars 316 forks source link

Consider splitting README into multiple docs #411

Open NyakudyaA opened 1 year ago

NyakudyaA commented 1 year ago

Feature description

The readme has become quite long and will continue to grow, let's consider splitting it and keep the main features here and flesh out most of the doc using either

GitHub wiki,
Github pages
Mkdocs.

We could have the following structure

README.md
docs/guide.md (Basics & Advanced Features)
docs/best-practices.md

Additional context

No response

NyakudyaA commented 1 year ago

This should fix #381

lewismc commented 1 year ago

👍