Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs - Client Manual #1211

Merged
merged 27 commits into from
Aug 10, 2022
Merged

Docs - Client Manual #1211

merged 27 commits into from
Aug 10, 2022

Conversation

jwrober
Copy link
Collaborator

@jwrober jwrober commented Aug 7, 2022

Brand new Client Manual for RTD. Closes #1058

@jwrober
Copy link
Collaborator Author

jwrober commented Aug 7, 2022

@lmoureaux , @pranavtifr , @daavko, maybe break this up into pieces. LM takes the first 9 commits, PR takes the next 8 and D takes the last 8?

@jwrober
Copy link
Collaborator Author

jwrober commented Aug 7, 2022

Here is a link to the generated content all in one -- https://longturn--1211.org.readthedocs.build/en/1211/General/Manuals/client-manual.html

@jwrober jwrober requested a review from daavko August 8, 2022 20:52
Copy link
Contributor

@lmoureaux lmoureaux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through "my" commits once and noted down remarks going from typos to metaphysical thoughts.

We may need to establish capitalization rules, because I don't think it's fully consistent within this PR, with the client, and within the documentation.

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
@daavko
Copy link
Collaborator

daavko commented Aug 10, 2022

Aside from my full review (which is in progress), we probably need concrete rules on usage of the Oxford comma. It's sometimes used, sometimes not. It'd be nice to be consistent.

Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 1/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 2/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 3/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 4/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 5/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 5/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 7/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
Copy link
Collaborator

@daavko daavko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 8/8

docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
@jwrober
Copy link
Collaborator Author

jwrober commented Aug 10, 2022

Aside from my full review (which is in progress), we probably need concrete rules on usage of the Oxford comma. It's sometimes used, sometimes not. It'd be nice to be consistent.

Good point. I've take a note to update in a future PR.

@lmoureaux
Copy link
Contributor

I'd like to take a second look before this is merged, there's a lot to digest 😅

docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
docs/General/Manuals/client-manual.rst Outdated Show resolved Hide resolved
@jwrober jwrober enabled auto-merge (rebase) August 10, 2022 22:03
@jwrober jwrober merged commit 8e8f075 into longturn:master Aug 10, 2022
@jwrober jwrober deleted the docs/client-manual branch August 10, 2022 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a Client Manual
4 participants