LOC-17: Build Documentation



Issue Information

Issue Type: Task
 
Priority: Major
Status: Closed

Reported By:
Ben Tasker
Assigned To:
Ben Tasker
Project: LocalChat (LOC)
Resolution: Done (2018-06-08 17:57:37)
Target version: V0.0.2,
Components: Client , Server ,

Created: 2018-05-14 09:15:37
Time Spent Working


Description
Now that the API is becoming a bit more stable, need to sit down and document it.

Should also generate a README for both client and server detailing how to operate them (in the server's case, it'll primarily be just recommended deployment methods for now)


Toggle State Changes

Activity


Repo: LocalChat
Host:Rimmer

commit 8c84012266d986e485dff57575243857c6436630
Author: B Tasker <github@<Domain Hidden>>
Date: Sat May 26 11:46:23 2018 +0100

Commit Message: LOC-17 Start creating README

Creating the root level README, currently only containing details on the recommended deployment methodology

README.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 119 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 9e59e8313aef1ad5b1af9a4b9f2dd2e378c4b104
Author: B Tasker <github@<Domain Hidden>>
Date: Sat May 26 12:00:24 2018 +0100

Commit Message: LOC-17 Create API documentation file

Doesn't contain much at the moment, it's a big TODO

docs/server-api.md | 33 +++++++++++++++++++++++++++++++++
1 files changed, 33 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 63278aa9ba659b7330522e4a4e31bc64d0bb49ef
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:11:36 2018 +0100

Commit Message: LOC-17 Document `pollMsg`

docs/server-api.md | 41 ++++++++++++++++++++++++++++++++++++++++-
1 files changed, 40 insertions(+), 1 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 190b4a2d2296ab65e0bc67a3de40bfccf8923f65
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:16:45 2018 +0100

Commit Message: LOC-17 Document sendMsg

docs/server-api.md | 36 ++++++++++++++++++++++++++++++++++++
1 files changed, 36 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit ff8b03d3dcf97301a032a2c847899d0859482b43
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:18:47 2018 +0100

Commit Message: LOC-17 Document `sendDirectMsg`

docs/server-api.md | 34 ++++++++++++++++++++++++++++++++++
1 files changed, 34 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit b693eead937ab5e7bb2420c2809cc9b601ad5e9b
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:25:38 2018 +0100

Commit Message: LOC-17 Document joinRoom

docs/server-api.md | 37 ++++++++++++++++++++++++++++++++++++-
1 files changed, 36 insertions(+), 1 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 720e173275f8c812b79fec2a32406ed0749fa4f7
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:34:13 2018 +0100

Commit Message: LOC-17 Document leaveRoom

docs/server-api.md | 19 +++++++++++++++++++
1 files changed, 19 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit a95d3aff0c206ced8958e2aced0cab077dab76f1
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:41:19 2018 +0100

Commit Message: LOC-17 Document closeRoom

docs/.server-api.md.kate-swp | Bin 0 -> 66 bytes
docs/server-api.md | 45 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 45 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 3beb8146a6adc3e8566ed22f5ad486c257c2b9b2
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:44:39 2018 +0100

Commit Message: LOC-17 Sort out swap file, and document inviteUser

docs/.server-api.md.kate-swp | Bin 66 -> 0 bytes
docs/server-api.md | 25 +++++++++++++++++++++++++
2 files changed, 25 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 058d576cd3a7a545a7e15aaa7a02f71618287a02
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:49:33 2018 +0100

Commit Message: LOC-17 Document kickUser and banUser

docs/server-api.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 48 insertions(+), 2 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit c3cf98e5764f1a2ffd4dcb9e9a125d8c27065455
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 09:57:09 2018 +0100

Commit Message: LOC-17 Add "Authentication" section

docs/server-api.md | 10 ++++++++++
1 files changed, 10 insertions(+), 0 deletions(-)


View Commit | View Changes
The API is now documented, allbeit in a fairly basic way. It can be improved over time though (for a start by adding more example responses in).

Also need to create a README for both the server and client components so that they can be used to document any CLI arguments they accept.
Repo: LocalChat
Host:Rimmer

commit c326d4d84e2b81faaa3aaa06594aee03dcdf3ce4
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 10:03:35 2018 +0100

Commit Message: LOC-17 Add (currently empty) README's for client and server

client/README.md | 26 ++++++++++++++++++++++++++
server/README.md | 23 +++++++++++++++++++++++
2 files changed, 49 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 6d1efd51de11cba845382f5317095dc5239db196
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 10:04:42 2018 +0100

Commit Message: LOC-17 Update main README to remove dependancies (to avoid duplication of info)

README.md | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit ec3fc4528a25364b78680e801b644f9ebd60d005
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 10:18:56 2018 +0100

Commit Message: LOC-17 Document client commands and update client help text

client/LocalChatClient.py | 14 +++++++++++---
client/README.md | 24 +++++++++++++++++++++++-
2 files changed, 34 insertions(+), 4 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 466c6f2c58fdf4b0201e4826eaa1c0a706724974
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 10:22:39 2018 +0100

Commit Message: LOC-17 Document client's supported commandline arguments

client/README.md | 12 ++++++++++++
1 files changed, 12 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 050410bd998aaa8fc0dcc8d1210fd550d25ba471
Author: B Tasker <github@<Domain Hidden>>
Date: Sun May 27 10:25:39 2018 +0100

Commit Message: LOC-17 Document server's commandline argument

server/README.md | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit e9138bae6cbb17d8ef567a8a727348124f871f9a
Author: B Tasker <github@<Domain Hidden>>
Date: Thu May 31 09:03:38 2018 +0100

Commit Message: LOC-17 Add note on forming message payloads

client/README.md | 20 ++++++++++++++++++++
1 files changed, 20 insertions(+), 0 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 42e6f61ba1b65b181b32a64b73427742fa062376
Author: B Tasker <github@<Domain Hidden>>
Date: Thu May 31 09:08:06 2018 +0100

Commit Message: LOC-17 Document client dependancies

client/README.md | 7 ++++++-
1 files changed, 6 insertions(+), 1 deletions(-)


View Commit | View Changes
Repo: LocalChat
Host:Rimmer

commit 3a4cbd0dce9b1c43fad2e53228cea5e54bd3b2e7
Author: B Tasker <github@<Domain Hidden>>
Date: Thu May 31 09:13:32 2018 +0100

Commit Message: LOC-17 Update server README

In principle, that's just the API docs to finish now

server/README.md | 20 +++++++++++++++-----
1 files changed, 15 insertions(+), 5 deletions(-)


View Commit | View Changes
btasker changed status from 'Open' to 'Resolved'
btasker added 'Done' to resolution
btasker changed status from 'Resolved' to 'Closed'