completely refactor README & parts of docs#3097
Conversation
I removed many parts of the `README` and placed them inside the docs. This was done to ensure we can properly version all of out documentation. I believe that users should generally **always use our documentation**, not a mixture of `README` + docs, to configure and check their mail server. This makes maintenance easier for maintainers as well as changes are local to the version. Previously, we had to keep `README` and docs in sync, which is undesirable. I took many parts of the READMe and copy-pasted it into the docs. Other parts were slightly adjusted to match the context. The landing page of our docs was more heavily refactored and updated to display more information. I also added notes on the versioning of the docs! There is actually more work to do cleaning up parts of the docs (a section on the examples chapter needs overhaul, etc.). But I did want to make this PR bigger - it is big enough.
More refactoring/rewording/adjustments of miscellaneous nature.
|
@wernerfred I you have the time, please provide me with some feedback and whether you think this is a good idea :) |
it absolutely is!
Finally, we should have done that much earlier!
It reads fantastic now imho. Much cleaner and futureproof! Thanks a lot! |
polarathene
left a comment
There was a problem hiding this comment.
Great work tackling this 😀
I'll apply my suggestions via the web UI.
|
Documentation preview for this PR is ready! 🎉 Built with commit: 14d5032 |
|
I resolved the conflicts and will merge it now :) |
Description
I removed many parts of the
READMEand placed them inside the docs. This is done to ensure we can properly version all of out documentation. I believe that users should generally always use our documentation, not a mixture ofREADME+ docs, to configure and check their mail server. This makes maintenance easier for maintainers, and changes are local to the version. Previously, we had to keep theREADMEand docs in sync, which is undesirable.I took many parts of the
READMEand copy-pasted it into the docs. Other parts were slightly adjusted to match the context. The landing page of our docs was more heavily refactored and updated to display more information.I also added notes on the versioning of the docs!
There is actually more work to do in cleaning up parts of the docs (a section in the examples chapter needs overhaul, etc.). But I did want to make this PR bigger - it is big enough.
@polarathene please, by all means, go ahead and apply suggested changes immediately without waiting for me. I'd only just apply them anyway :) This way we can make reviewing faster. I hope you think the changes a worthwhile.
Type of change
Checklist:
docs/)