Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 576ea7f

Browse files
DanielVFmicahalcorn
authored andcommitted
[Docs] Update high level documentation for each software service. (#3800)
* Update high level documentation for each software service. And move software pages into main section for now. * Add current system diagram. Move software back to it’s own folder. * Remove accidental file * Update Messaging concept doc * Tweak software overview page title. * Color revamp for docs to match new main Origin site. * Fix typos * Add growth and auth servers. * Handle some outdated copy
1 parent 2f11e9d commit 576ea7f

35 files changed

+823
-436
lines changed

Diff for: docs/_layouts/page.html

+4-20
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,12 @@
1010
</head>
1111
<body>
1212
<div class="header">
13-
<div class="logo"><a href="/">Origin Documentation</a> Docs</div>
14-
<nav>
15-
<a class="topNav {% unless page.dir contains 'software' %}current{% endunless %}" href="/">Overview</a>
16-
<a class="topNav {% if page.dir contains 'software' %}current{% endif %}" href="/software/">Software</a>
17-
</nav>
13+
<div class="logo"><a href="/"><img src="/assets/[email protected]" height="23" alt="Origin Protocol logo"></a></div>
1814
</div>
1915

2016
<div class="layout">
2117
<div class="sidebar">
22-
{% assign menuPages = site.pages %}
23-
{% if page.dir contains "software" %}
24-
{% assign menuPages = site.pages | where_exp:"page",
25-
"page.dir contains 'software'" %}
26-
{% elsif page.dir contains "guides" %}
27-
{% assign menuPages = site.pages | where_exp:"page",
28-
"page.dir contains 'guides'" %}
29-
{% else %}
30-
{% assign menuPages = site.pages | where_exp:"page",
31-
"page.dir contains 'guides'" %}
32-
{% endif %}
33-
34-
35-
{% assign menuPages = menuPages | sort: 'nav_weight' | reverse %}
18+
{% assign menuPages = site.pages | sort: 'nav_weight' | reverse %}
3619
{% assign pageGroups = menuPages | group_by: "category" %}
3720
<ul>
3821
{% for cat in pageGroups %}
@@ -42,7 +25,8 @@
4225
{% endif %}
4326
{% for p in cat.items %}
4427
<li class="normal">
45-
<a href="{{ p.url }}">{{ p.title }}</a> <!-- {{ p.nav_weight }}-->
28+
<a href="{{ p.url }}">{% if p.menu_title%}{{ p.menu_title }}{% else %}{{ p.title }}{% endif %}</a>
29+
4630
{% if p.toc == true and p.url == page.url %}
4731
{{ content | toc_only }}
4832
{% endif %}

Diff for: docs/assets/css/site.css

+2-5
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,11 @@ th {
6565
display: flex;
6666
flex-direction: row;
6767
padding:20px;
68-
background-color:#111d28;
68+
background-color:#007cff;
6969
}
7070
.header > .logo {
7171
padding-left:10px;
72-
background-image:url('/assets/origin-logo-white.png');
73-
background-repeat: no-repeat;
74-
text-indent:-999px;
75-
width:98px;
72+
width:99px;
7673
height:23px;
7774
}
7875

Diff for: docs/assets/origin-logo-white.png

-1.94 KB
Binary file not shown.

Diff for: docs/assets/origin-logo.png

-5.78 KB
Binary file not shown.

Diff for: docs/assets/[email protected]

4 KB
Loading

Diff for: docs/guides/concepts/messaging.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,10 @@ nav_weight: 1
55
category: "Concepts"
66
---
77

8-
(To be Written...)
8+
Origin messaging provides end to end encrypted communication between two users, using ethereum addresses as their identity.
9+
10+
A room is everything exchanged between two users. Each room uses its own derived keys. This allows a user to give an arbitrator access to only the conversations between themselves and their counterparty, without having to open up other conversations.
11+
12+
At a data level, a room is a list of both the messages from either party and the public keys used between them.
13+
14+
Currently Origin Messaging hosts a service to exchange encrypted room messages, however more distributed message exchanges are possible.

Diff for: docs/guides/getting_started/contributing.md

+13-24
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ We use a monorepo for almost all of our development -- see [Origin](https://gith
1313

1414
You are most likely interested in these projects inside the monorepo:
1515

16-
- [Origin.js](https://github.com/OriginProtocol/origin/tree/master/origin-js#origin-js) - Solidity contracts and JavaScript API
17-
- [Origin DApp](https://github.com/OriginProtocol/origin/tree/master/origin-dapp#origin-dapp) - example React-powered decentralized application
18-
- [Origin Bridge Server](https://github.com/OriginProtocol/origin/tree/master/origin-bridge#origin-bridge-server) - Python and JavaScript for indexing, attestations, and messaging
19-
- [Origin Box](https://github.com/OriginProtocol/origin/blob/master/DEVELOPMENT.md#using-docker-compose) - Docker container for simplifying local development
16+
- [Marketplace DApp](https://github.com/OriginProtocol/origin/tree/master/dapps/marketplace) - React-powered decentralized application built on Origin's platform
17+
- [Core Packages](https://github.com/OriginProtocol/origin/tree/master/packages) - A suite of smart contracts and standards for creating listings, offers, and identities on decentralized marketplaces
18+
- [Infrastructure](https://github.com/OriginProtocol/origin/tree/master/infra) - Services enabling functionality that is either impossible or impractical to do directly on-chain, such as indexing, messaging, and notifications
19+
- [Mobile App](https://github.com/OriginProtocol/origin/tree/master/mobile) - Native application that offers a fully-integrated marketplace experiences with a built-in Ethereum wallet
2020

2121
Other repos of interest:
2222

@@ -31,7 +31,7 @@ We work in public and our company Discord is open to all. If you have questions
3131

3232
We have an open weekly engineering call on Google Hangouts every Wednesday at 12:30 Pacific Time. [Add to Calendar](https://calendar.google.com/event?action=TEMPLATE&tmeid=YXBiOThhc2s3cnE4NGltMXFwbWhpY3ZpNm9fMjAxOTAxMDlUMjAzMDAwWiBtaWNhaEBvcmlnaW5wcm90b2NvbC5jb20&tmsrc=micah%40originprotocol.com&scp=ALL)
3333

34-
![Origin Engineering Call](/source/images/origin_engineering_call.png "Origin Engineering Call")
34+
<div style="background-color: #061d2a; border: 30px solid #061d2a;"><img src="/source/images/last-sun-oct.svg" alt="Origin Engineering Call" /></div>
3535

3636
Join the call here: [https://meet.google.com/pws-cgyd-tqp](https://meet.google.com/pws-cgyd-tqp)
3737

@@ -42,17 +42,14 @@ Everyone is welcome to join, even if you're just lurking. All we ask is that you
4242

4343
## Dive Right In
4444

45-
If you're ready to start hacking on Origin right now and you just need an issue to focus on, check out our [open issues](https://github.com/search?utf8=%E2%9C%93&q=user%3AOriginProtocol+is%3Aopen+&type=Issues) especially those tagged as a [good first issue](
46-
https://github.com/search?utf8=%E2%9C%93&q=user%3AOriginProtocol+is%3Aopen++label%3A%22good+first+issue%22&type=Issues&ref=advsearch&l=&l=).
45+
If you're ready to start hacking on Origin right now and you just need an issue to focus on, check out our ["good first issues"](https://github.com/OriginProtocol/origin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [let one of us know](https://www.originprotocol.com/discord) which one you plan to tackle.
4746

48-
We use two week development sprints and you can see what we're currently prioritizing on [our Github project board](https://github.com/orgs/OriginProtocol/projects/2).
47+
We use [ZenHub](https://www.zenhub.com/) to manage our engineering tasks and product development. [Download their browser extension](https://www.zenhub.com/extension) and check out our open workspace at [github.com/originprotocol/origin#zenhub](https://github.com/originprotocol/origin#zenhub).
4948

5049
Read our [development process](#contributing-email-development-process) and [community guidelines](#contributing-email-community-guidelines) first and have fun!
5150

5251
## Development Process
5352

54-
Getting your local environment running is easy with [Origin Box](https://github.com/OriginProtocol/origin/tree/master/development#origin-box). We recommend using this Docker container for any development or testing that involves running a local blockchain.
55-
5653
Our branching strategy is similar to [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/), but we do all of our development in the `master` branch and have a `stable` branch for code that has been released.
5754

5855
Your development flow should look like:
@@ -76,12 +73,6 @@ For JavaScript, we use [NPM's style](https://docs.npmjs.com/misc/coding-style),
7673

7774
For Solidity, we use two space indents.
7875

79-
## Troubleshooting a Development Environment
80-
81-
* If you encounter errors while executing `npm install` for any of the Origin repositories, try running a recent LTS version of Node.js. [nvm](https://github.com/creationix/nvm) is a tool that can install specific versions of Node.js. After installing `nvm`, run `nvm install --lts`, remove your `node_modules` directory, and run `npm install` again.
82-
83-
* If you are using `origin-box` Docker setup and are running OSX Sierra below 10.13.4 Docker volumes might randomly stop syncing. This results in problems where host machine source code updates do not get propagated to file system inside Docker. To resolve this issue update OSX Sierra to 10.13.4 or above. See [this thread](https://github.com/EugenMayer/docker-sync/issues/517) for more details.
84-
8576
## Protocol Design
8677

8778
When considering protocol or implementation design proposals, we are looking for:
@@ -108,24 +99,22 @@ We want to keep the Origin community awesome, growing and collaborative. We need
10899

109100
## Reporting Issues
110101

111-
If you find bugs, mistakes or inconsistencies in the Origin project's code or
112-
documents, please let us know by filing an issue at the appropriate issue
113-
tracker (we use multiple repositories).
102+
If you find bugs, mistakes or inconsistencies in Origin's code or
103+
documents, please let us know by filing a GitHub issue.
114104

115105
<aside class="notice">
116106
No issue is too small. Help us fix our tpyos!
117107
</aside>
118108

119109
- [Good first issues](https://github.com/OriginProtocol/origin/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+)
120110
- [Docs issues](https://github.com/OriginProtocol/origin/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Adocs)
121-
- [Origin.js issues (JS API & Solidity contracts)](https://github.com/OriginProtocol/origin/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Aorigin.js)
122111
- [DApp issues](https://github.com/OriginProtocol/origin/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Adapp)
123112
- [Playground issues](https://github.com/OriginProtocol/origin-playground/issues)
124113
- [Company website issues](https://github.com/OriginProtocol/origin-website/issues)
125114

126115
## Security Issues
127116

128-
The Origin Protocol and its implementations are still in early development, which means there may be problems with the protocol or in our implementations. We take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away!
117+
Origin is still in early development, which means there may be problems with the protocol or in our implementations. We take security vulnerabilities very seriously. If you discover a security issue, please bring it to our attention right away!
129118

130119
If you find a vulnerability please send your report privately to [[email protected]](mailto:[email protected]) or [contact Josh Fraser via Keybase](https://keybase.io/joshfraser). Please DO NOT file a public issue.
131120

@@ -137,12 +126,12 @@ Origin is just as much about community as it is about our technology.
137126

138127
We need constant help in improving our documentation, building new tools to interface with our platform, spreading the word to new users, helping new users getting setup and much more.
139128

140-
Please get in touch if you would like to help out. Our `general` channel on [Discord](https://discord.gg/jyxpUSe) is a great place to share ideas and volunteer to help.
129+
Please get in touch if you would like to help out. Our `general` channel on [Discord](https://www.originprotocol.com/discord) is a great place to share ideas and volunteer to help.
141130

142131
## Full Time Positions
143132

144133
Origin occasionally hires developers for part time or full time positions.
145134

146-
We have a strong preference for hiring people who have already started contributing to the project. If you want a full time position on our team, your best shot is to engage with our team and start contributing code. It is very unlikely that we would offer you a full time position on our engineering team unless you've had at least a few pull requests merged.
135+
We have a strong preference for hiring people who have already started contributing to the project. If you want a full time position on our team, your best shot is to engage with our team and start contributing code. It is very unlikely that we would offer you a full-time position on our engineering team unless you've had at least a few pull requests merged.
147136

148-
If you are interested, check out [the Origin Protocol job listings](https://angel.co/originprotocol/jobs). If you'd like to help in other ways, please propose your ideas in the [Origin Discord](https://discord.gg/jyxpUSe).
137+
If you are interested, check out [the Origin Protocol job listings](https://angel.co/originprotocol/jobs). If you'd like to help in other ways, please propose your ideas in [our Discord channel](https://www.originprotocol.com/discord).

Diff for: docs/guides/getting_started/getting-started.md

-59
This file was deleted.

Diff for: docs/guides/getting_started/local-development.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,13 @@ npm start
3636

3737
4. You will then need to connect to your locally running blockchain in MetaMask. Follow these steps:
3838

39+
- ⚠️ ***Be 100% sure that you have your existing wallet backed up!***
40+
3941
- Log out of MetaMask.
4042

4143
- Click `Restore from seed phrase`
4244

43-
- Enter the following seed phrase (Mnemonic):
45+
- Enter the following seed phrase (mnemonic):
4446

4547
```
4648
candy maple cake sugar pudding cream honey rich smooth crumble sweet treat
@@ -146,7 +148,7 @@ If a container is failing with code 137 it could be that it has encountered Out
146148

147149
#### Port errors
148150

149-
The environment requires a number of ports to be free on your machine (3000, 5000, 5002, 8080, 8081 and 8545). If one of these ports isn't available spinning up the development environment may fail.
151+
The environment requires a number of ports to be free on your machine (3000, 5000, 5002, 8080, 8081 and 8545). If one of these ports isn't available, spinning up the development environment may fail.
150152

151153
#### Metamask errors
152154

Diff for: docs/guides/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,26 @@ category: "Overview"
66
permalink: /
77
---
88

9-
Origin provides a simple and powerful javascript library for developers to build decentralized marketplaces, allowing buyers and sellers to meet and transact without requiring any trusted intermediaries.
9+
Origin provides a simple and powerful JavaScript library for developers to build decentralized marketplaces, allowing buyers and sellers to meet and transact without any trusted intermediaries.
1010

1111
### Usage
1212

13-
Visit our Github: [https://github.com/OriginProtocol](https://github.com/OriginProtocol)
13+
Visit our GitHub: [https://github.com/OriginProtocol](https://github.com/OriginProtocol)
1414

15-
This API documentation will explain how developers can use the origin.js library to create and manage decentralized marketplaces that are built on top of [IPFS](https://github.com/ipfs) and the [Ethereum network](https://www.ethereum.org/).
15+
This documentation will explain how developers can use the Origin platform to create and manage decentralized marketplaces that are built on top of [IPFS](https://github.com/ipfs) and the [Ethereum network](https://www.ethereum.org/).
1616

17-
Origin.js aims to create an easy and flexible abstraction layer that:
17+
Origin aims to create an easy and flexible abstraction layer that:
1818

1919
* Generates and deploys secure Ethereum smart contracts to the blockchain.
2020
* Creates and posts user and listing metadata to distributed IPFS nodes
2121
* Queries against open-source indexing servers to render content in decentralized applications (DApps)
2222

23-
Origin.js enables developers to create DApps that onboard new users to the Origin platform, add new listings to the listings registry, create booking contracts, close out bookings (transfer funds, write reviews, etc.), and more.
23+
Origin enables developers to create DApps that allow users to create listings, make purchases, manage their identities, and more.
2424

2525
### Notes
2626

27-
Please note this project is still in heavy development and many of the features described below have not been implemented yet. This library should not be considered as production-ready.
27+
Please note that this project is still under heavy development and many necessary features have not yet been implemented. This library should not be considered production-ready.
2828

29-
Origin.js and the entire Origin Protocol project is 100% open-source and we welcome contributions from the community. There are many ways to help, from reporting issues and contributing code to helping us improve and grow our community.
29+
The entire Origin Protocol project is 100% open-source and we welcome contributions from the community. There are many ways to help, from reporting issues and contributing code, to helping us improve and grow our community.
3030

31-
If you are interested in getting involved, please read our section on [contributing](getting_started/contributing.md). If at any point you get stuck, please [reach out](#getting-help) and we'll do our best to help.
31+
If you are interested in getting involved, please read our section on [contributing](getting_started/contributing.md). If at any point you get stuck, please contact us on #engineering in [Discord](https://originprotocol.com/discord).

0 commit comments

Comments
 (0)