overthesun / simoc

A scalable model of an interactive, off-world community
https://ngs.simoc.space/
GNU General Public License v3.0
2 stars 1 forks source link

Update documentation #396

Closed ezio-melotti closed 1 year ago

ezio-melotti commented 1 year ago

This PR brings the docs up to date, and includes the following changes:

kstaats commented 1 year ago

Ezio,

On 7/13/23 17:20, Ezio Melotti wrote:

@ezio-melotti requested your review on: overthesun/simoc#396 Update documentation.

A few things to change:

https://github.com/overthesun/simoc/pull/396/commits/aacf740fa41404c2497b5fcb33c7c4f8df982f00

Line 50: copyright = 'Over the Sun, LLC'

OTS owns SIMOC, and should be copyright maintainer of the docs too, for solid legal reasons.

If we were to invoke a collective copyright for the docs, "The SIMOC Team" is not a legal entity and would not hold up in court. Instead, we'd need to list each team member by name.

We should probably review all copyright notes across the board, to make certain we have it right.

https://github.com/overthesun/simoc/pull/396/commits/9bad740016d10b2f014e22775791d34f6de246ba

Well done. Clear, concise instructions.

https://github.com/overthesun/simoc/pull/396/commits/3538e2abe450b283c944432b80e2a0d163552af7

Line 88: I suggest "should not" over the contraction "shouldn't" as this form of English can be a bit confusing for ESL readers, and it just looks more professional :)

kai

kstaats commented 1 year ago

Ezio,

On 7/13/23 17:20, Ezio Melotti wrote:

@ezio-melotti requested your review on: overthesun/simoc#396 Update documentation.

A few things to change:

https://github.com/overthesun/simoc/pull/396/commits/aacf740fa41404c2497b5fcb33c7c4f8df982f00

Line 50: copyright = 'Over the Sun, LLC'

OTS owns SIMOC, and should be copyright maintainer of the docs too, I believe. But if we were to invoke a collective copyright for the docs, "The SIMOC Team" is not a legal entity and would not hold up in court. Instead, we'd need to list each team member by name.

We should probably review all copyright notes across the board, to make certain we have it right.

https://github.com/overthesun/simoc/pull/396/commits/9bad740016d10b2f014e22775791d34f6de246ba

Well done. Clear, concise instructions.

https://github.com/overthesun/simoc/pull/396/commits/3538e2abe450b283c944432b80e2a0d163552af7

Line 88: I suggest "should not" over the contraction "shouldn't" as this can be a bit confusing for ESL readers, and it just looks more professional :)

Cheers kai