Add guidelines for semantic line feeds to contribution section (#506)

[Hooverdan96]

Fixes #506.

This pull request's proposal

Inside the Contribution to Documentation section

• Add to the guidelines a section for semantic line feeds
• Add sentence case guideline for Headings

Checklist

• With the proposed changes no Sphinx errors or warnings are generated.
• I have added my name to the AUTHORS file, if required (descending alphabetical order).

[Hooverdan96]

@phillxnet, please take a look.

the only link that seems to fail is:

(interface/overview: line 178) broken https://www.duckdns.org/ - 404 Client Error: Not Found for url: https://www.duckdns.org/

which is a "fake failure". The duckdns website itself is notorious for "breaking" depending on which dns server is used from what I understand.

[phillxnet]

@Hooverdan96 This is really good, thanks for stepping up to get this done. I'm now a real fan of Semantic linefeeds in docs so it's good that we finally have this as an up-front request on our doc repos now. Pertinent to the issue this all looks great, and I like your additions and improvements. Thanks also for the meta re-format :) .

I'll get this merged and published shortly.

[phillxnet]

I did a local formatting test and all looks to be as expected here. Shame we ran into yet another linkcheck fail - I only just fixed one earlier today.

[phillxnet]

PRODUCTION published

[phillxnet]

@FroggyFlox & @Hooverdan96 I see in this doc section that we have had a long standing sudo: I'm thinking this is not actually required and likely in error. But again this is nothing to do with your changes here in this PR. Just wanted to flag it as I only noticed while doing the review. I.e. if we are installing for --user (the default these days) we shouldn't need elevated privaledges.

[Hooverdan96]

we have had a long standing sudo: I'm thinking this is not actually required and likely in error

Should this be reformulated as a virtual environment entirely (which would make the --user option also superfluous)? Or is that overkill?

[phillxnet]

@Hooverdan96 I think a Python virtual env would be over-kill, plus we do have the docker option for complete isolation. We likely just need to remove the sudo I think. I've yet to prove this however, I just wanted to note it for future attention as if we can do without this then it would be better.