status-im
/
specs
mirror of https://github.com/status-im/specs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Specifications for Status clients. https://specs.status.im/
404 Commits 46 Branches 0 Tags 4 MiB
HTML 77%
JavaScript 20.9%
Ruby 2.1%
Go to file
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
.github/workflows spellcheck (#119) 2020-05-19 18:40:48 +02:00
assets Update spec lifecycle 2020-03-24 14:11:07 +08:00
docs clean up docs headers, add layout to all 2021-11-22 19:47:57 +01:00
scripts ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
.gitignore ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
.remarkrc adds check, fixes links (#124) 2020-05-21 11:44:13 +02:00
.textlintrc text-lint (#131) 2020-05-25 14:18:39 +02:00
CNAME add CNAME for GH pages 2020-03-23 10:58:39 +01:00
DEVELOPMENT.md clean up docs headers, add layout to all 2021-11-22 19:47:57 +01:00
Gemfile ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
Gemfile.lock ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
Jenkinsfile ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
README.md ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
STYLE-GUIDELINE.md clean up docs headers, add layout to all 2021-11-22 19:47:57 +01:00
_config.yml ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
_config_local.yml add Jekyll config for local builds 2021-09-13 10:00:48 +02:00
default.html explicit layouts 2020-03-30 13:34:21 +08:00
home.html explicit layouts 2020-03-30 13:34:21 +08:00
package-lock.json text-lint (#131) 2020-05-25 14:18:39 +02:00
package.json ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00
post.html explicit layouts 2020-03-30 13:34:21 +08:00
spellcheck.yaml spellcheck (#119) 2020-05-19 18:40:48 +02:00
wordlist.txt clean up docs headers, add layout to all 2021-11-22 19:47:57 +01:00
yarn.lock ci: add Jenkinsfile and deploy script 2021-11-22 19:47:57 +01:00

README.md

layout permalink nav_exclude
default / true

Specifications for Status clients

CI

This repository contains a list of specifications for implementing Status and its various capabilities.

How to contribute

You can read about how to build this project here.

  1. Create an issue for a new Status Improvement Proposal (SIP) or some bug that you'd like to address
  2. Create a corresponding PR and ping some existing SIP editors for review

If you need help, ask in #protocol at Status / Discord.

Specification style guidelines

Become familiar with the specification style guidelines to understand how you should write or amend specifications.

Spec lifecycle

Every spec has its own lifecycle that shows its maturity. We indicate this in a similar fashion to COSS Lifecycle:

At present (March 30, 2020) this means stable specs are what is in v1 of the Status App. Drafts and raw are work in progress specs.

Status Improvement Proposals (SIPs)

The main specification for writing a Status client is 1/CLIENT.

For all full index of all specs, see specs.status.im, especially stable specs.

Protocol Research

These are protocols that are currently being researched. These are designed to be useful outside of Status as well. To the extent that these protocols are used within Status clients, they will show up as SIPs in the future.

To see more on this, please visit the current home: vac protocol.

Continuous Integration

The site is built in Our Jenkins CI based off of master branch.