Splits docs to use three different `permalink` paths:
- `/raw/`
- `/draft/`
- `/stable/`
Otherwise docs like these clash and only one is accessible:
```
docs/draft/3-whisper-usage.md
docs/stable/3-whisper-usage.md
```
```
docs/draft/6-payloads.md
docs/stable/6-payloads.md
```
Signed-off-by: Jakub Sokołowski <jakub@status.im>
* Added EmojiReaction payload types
* I'm an author now
* wordlist update
* Moved MessageType protobuf into dedicated section
With the inclusion of emoji reactions the MessageType protobuf was split out from the ChatMessage protobuf so that the MessageType enums could be used in multiple protobuf message types.
## What has changed?
I've added detailed specs for the implementation of public key compression and decompression. The specifications detail the use of the following `multiformat` features:
- `multibase`
- `multicodec`
- `unsigned-varint`
`multiformat` is used to ensure that the implementation has as much flexibility and robustness as feasible.
## Why make the change?
The usage of key de/compression is outside the typical usage of public keys and requires a degree of background knowledge to correctly implement. The purpose of this specification change is to provide this needed background knowledge.
Please also see
- https://github.com/status-im/status-go/issues/1937
- https://github.com/status-im/status-go/pull/1990
---
* Added Public key compression specs
* Added recommendation for encoding type of compressed keys
* Added unrecognised words to wordlist
* Add multibase to the wordlist
* Added a basic example of the multiformat EC key compression concept
* Added parsable to wordlist
* Hex is the only Lingua Franca we need
* Language to make pk de/compression SHOULD implement
* Added terms to glossary explaining key de/compression
* Change terminology from compress to serialise
* Added rationale for public key compression
* Added deserialization to the wordlist
* Concise sentence
* Added url to the wordlist
Resolves#115
* Rewrote 'you' and 'your' personal pronouns
Additionally I've made related sentences more concise. NOTE I've ignored usages of you and your in comments and in links and section titles
* Rewrote 'we' personal pronouns
Again not changing usages in comments
* Removed 'passive' and/or ambiguous language
* Added README information about language mode
* Added prepend to word list
* Update README.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
* Update docs/draft/3-whisper-usage.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
* Update docs/draft/3-whisper-usage.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
* Added missing 'a's
* Moved style related README info into STYLE-GUIDELINE.md
* Added reference to Google Technical Writing
* Tweaks to maintain consistency of changes across related specs
* Addressed spelling and added link to the Discord server
* Update docs/draft/12-sticker-pack.md
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
* Update docs/draft/13-3rd-party.md
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
* Update docs/draft/13-3rd-party.md
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
* Update docs/draft/13-3rd-party.md
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
* Update docs/stable/11-waku-mailserver.md
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
* Addressed feedback
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Co-authored-by: Kim De Mey <kim.demey@gmail.com>
Introduces Waku in to the relevant places in the specs.
* First draft changes to 1-client.md
* initial waku replace work on 2-account.md
* Rename 3-whisper-usage to waku
There may be broken links after this change
* Initial update for 3-waku-usage.md
* Adjustment to use WHISPER concurrently with WAKU
* Converting 'moving away from whisper' section to `why use waku`
* Added clarification about Open Whisper Systems X3DH usage
* Updated transport privacy, include both whisper and waku
* Updated 1-client, language supports concurrent whisper and waku
* Updated 2-account.md to be whisper/waku concurrent
* Reverted 3-whisper-usage changes, added 9-waku-usage
* Complete revert of 3-whisper-usage
* revert 3-whisper-usage.md
* Fix to 3-whisper-usage.md links
* Update docs/stable/1-client.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
* Removal of personal pronouns from 1-client.md
* Update to 5-secure-transport.md
* Implemented combined 'whispe/ waku relayer' role
* Addressed ambiguous and stale links in 6-payloads
* Updated 6-payloads
* Fix broken / stale links in 7-group-chat.md
* Fixed stale link 8-eips
* link fix and todo resolved for 1-client.md
* Added 10-waku-mailserver document
* Added gitignore
* Minor tweaks and fixes
* Added Whisper / Waku briding section to 3-whisper-usage
* Updated 10-waku-mailserver
* Updated 9-waku-usage.md
* Made changes to keep Mailserver term consistent
* Removed some redundant comments
* Removed seemingly vistigual '???'
* Including large payload PoW
See 7b6af0a7cc/protocol/message_processor.go (L25-L35)
* Changed 'mail server' to 'Mailserver'
* Added details about status-options
* Implemented final changes before review
* Tpyo fix
* Removed incorrect reference to topic-interest
* removed .gitignore, defer to global_gitignore
* Addressing feedback
* Revert draft/7 link fix
Readdressed in GH-120
* Reverted link fixes for stable/5
Addressing in GH-120
* Revert tpyo fix
Addressed in GH-119
* Reverted stable/6 link fixes
Addressed in GH-120
* Missed a minor link change
* Revert link fix in stable/1
Addressed in GH-120
* Revert tpyo fix in stable/1
Addressed in GH-119
* Revert stable/1 link fix
Addressed in GH-120
* Revert stable/2 link fix
Addressed in GH-120
* Revert link fix to stable/2
* Revert stable/3 link fixes
Addressed in GH-120
* Revert adding missing topic link
Addressed in GH-120
* Revert stable/4 link fix
Addressed in GH-120
* Revert stable/5 link fix
Addressed in GH-120
* Revert stable/8 link fix
Addressed in GH-120
* Partial revert of stable/1 node roles
* Resolved whispermail reference query
See GH-125
* Added changelog and version bump ...
Added my name where appropriate and addressed some minor issues
* Added consistent capitalisation to 'Whisper'
* Resolved jRPC call issue for waku
* Updated spelling
* Addressing minor feedback issues
* Update docs/stable/10-waku-mailserver.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
* Update docs/stable/10-waku-mailserver.md
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Jakub Sokołowski
Andrea Maria Piana
Samuel Hawksby-Robinson
yenda
Vitaliy Vlasov
Roman Volosovskyi
Dean Eigenmann