Commit Graph

67 Commits

Author SHA1 Message Date
Jakub Sokołowski 43341489eb add Creative Commons copyright to all docs
Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-11-22 19:47:57 +01:00
Jakub Sokołowski 6ba977e701 clean up docs headers, add layout to all
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>
2021-11-22 19:47:57 +01:00
Franck Royer 06db81da79
Add link to superscripts (#157) 2021-10-11 12:04:26 +11:00
Hanno Cornelius 4376df7e05
Fix broken links to vacp2p specs (#156) 2021-08-30 10:15:57 +02:00
Andrea Maria Piana 576a7d9b28 add author 2020-10-05 13:21:04 +02:00
Andrea Maria Piana 81e790cd65 Add mentions push notifications 2020-10-05 13:21:04 +02:00
Samuel Hawksby-Robinson 99e1b19a6d
Updated release commit (#147) 2020-09-07 11:54:57 +01:00
Samuel Hawksby-Robinson 968fafff23
Added EmojiReaction payload types (#145)
* 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.
2020-08-25 13:13:02 +01:00
Andrea Maria Piana 3692daacf7 Add grant, separate devices and ephemeral keys usage 2020-08-24 16:24:32 +02:00
Andrea Maria Piana a43a6b5a9f add changelog 2020-07-23 10:43:36 +02:00
Andrea Maria Piana 382187b92a Add audio messages 2020-07-23 10:43:36 +02:00
Andrea Maria Piana 7decaea2ff Address feedback and generate access_token on the client side 2020-07-02 10:08:13 +02:00
Andrea Maria Piana ff82702c27 Push notification server initial version 2020-06-24 15:36:11 +02:00
Samuel Hawksby-Robinson 48d08c7667
Add release commit info for Update/key compression (#142)
* Added release commit to version info
2020-06-24 12:52:06 +01:00
Oskar Thorén ec6f278366
Update Dapp spec to free number (#140)
* Update Dapp spec to free number

It replaced 10 waku usage which made https://specs.status.im/spec/10 link wrong

* Rename webview.md to 14-DAPP-BROWSER.md
2020-06-24 18:21:25 +08:00
Samuel Hawksby-Robinson e98a9b76b7
Added public key compression specs (#137)
## 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
2020-06-24 11:16:45 +01:00
Oskar Thorén 5aa330c124
Delete basically empty specs (#141)
* Delete basically empty specs 

Superseded by real draft specs already, no content here.

* Delete status-storage-spec.md
2020-06-24 15:28:32 +08:00
yenda 046f865eb6
mentions (#105) 2020-06-15 14:43:21 +02:00
yenda 073cf26949
notifications draft (#104) 2020-06-15 14:40:56 +02:00
Vitaliy Vlasov dafcd4fb15
Add Browser API doc (#108)
Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-06-15 14:25:37 +03:00
Roman Volosovskyi 5cf5307155
Keycard 2020-06-12 09:14:57 +03:00
Samuel Hawksby-Robinson b21d87ef8f
Remove personal pronouns (#132)
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>
2020-06-03 23:02:45 +01:00
Dean Eigenmann 7355f4cff0
text-lint (#131) 2020-05-25 14:18:39 +02:00
Dean Eigenmann 93dc975914
Update 1-client.md (#128)
Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-05-25 11:49:00 +02:00
Samuel Hawksby-Robinson 8ef27a2e10
Update/sequence specs (#130)
* re-sequenced new spec numbers

resolves GH-127

* re-sequenced new spec numbers

resolves GH-127
2020-05-25 09:29:11 +01:00
Samuel Hawksby-Robinson 8903dcab95
Added release information to changelogs (#129) 2020-05-22 15:44:54 +01:00
Samuel Hawksby-Robinson 664dd1c9df
Update/waku replace (#114)
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>
2020-05-22 15:05:21 +01:00
Dean Eigenmann c22a9e8d5e
adds check, fixes links (#124) 2020-05-21 11:44:13 +02:00
Dean Eigenmann 56d5a2ff39
spellcheck/broadcasted-broadcast (#122)
* Update 3-whisper-usage.md

* Update wordlist.txt
2020-05-20 17:15:30 +08:00
Andrea Maria Piana 547a200a47 Update with PoW changes 2020-05-20 08:44:38 +02:00
Andrea Maria Piana c87f91cc60 Move whisper usage to draft 2020-05-20 08:44:38 +02:00
Dean Eigenmann 55d210c30e
spellcheck (#119)
* spellcheck

* updated

* Create f.yml

* Delete f.yml

* fix

* only on pr

* fix

* spellcheck

* attempt

* more

* updates

* fix

* more

* updates

* updated

* more

* more words

* even more

* updates

* fix

* sort

* more

* updates

* updated

* sort

* Update docs/stable/6-payloads.md

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>

Co-authored-by: Samuel Hawksby-Robinson <samuel@samyoul.com>
2020-05-19 18:40:48 +02:00
Andrea Maria Piana d093781369
Merge pull request #110 from Ferossgp/patch-1
Add spec for IPFS gateway for Sticker Pack
2020-05-19 08:17:06 +02:00
Volodymyr Kozieiev 63c530a7be
Merge pull request #111 from status-im/3rdparty
Third party api used for core functinality
2020-05-18 12:02:31 +03:00
Volodymyr Kozieiev 36edf7cecb
Updated link 2020-05-18 12:00:44 +03:00
Andrea Maria Piana 87cab77f20
Merge pull request #107 from status-im/feature/image-sending
Image content type for chat messages
2020-05-15 12:13:19 +02:00
Andrea Maria Piana 7a6fbe5af0
Merge pull request #106 from status-im/feature/blockchain-interactions
Ethereum usage
2020-05-15 12:12:47 +02:00
Volodymyr Kozieiev 48e099e087
Fix notes 2020-05-15 12:15:52 +03:00
Gheorghe Pinzaru 8799b31c80
Apply suggestions from code review
Co-authored-by: Oskar Thorén <me@oskarth.com>
2020-05-15 12:15:15 +03:00
Andrea Maria Piana 130f9790e5
Address feedback 2020-05-15 10:28:10 +02:00
Andrea Maria Piana 8f77469555
Address feedback 2020-05-15 09:17:17 +02:00
Gheorghe Pinzaru 7607cdc3f3
Update sticker pack contenthsh example 2020-05-13 17:01:49 +03:00
Gheorghe Pinzaru 26a75a880e
Text style fixes
Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
2020-05-13 16:02:19 +03:00
Volodymyr Kozieiev f5e71d2a91
Addressed comments 2020-05-12 13:45:29 +03:00
Gheorghe Pinzaru 263d904796
Follow up review comments 2020-05-08 10:31:50 +03:00
decanus 1bebe99593
Merge branch 'master' into eip-1459 2020-05-06 16:47:07 +02:00
Gheorghe Pinzaru c3b5e9c053
Misspelling
Co-authored-by: yenda <yenda1@gmail.com>
2020-05-04 15:42:47 +03:00
Andrea Maria Piana 237ad01f8f
address feedback 2020-05-04 13:51:52 +02:00
Volodymyr Kozieiev a12d4338c4
TOC added 2020-05-04 11:24:20 +03:00
Volodymyr Kozieiev f38daeee2d
Draft of 3rd party api spec 2020-05-04 11:14:18 +03:00