Origin: New docs review time!

Created on 11 Jan 2019  路  4Comments  路  Source: OriginProtocol/origin

Our new docs are up at https://docs.originprotocol.com/!

It's time for a quick review! I've tagged people on pages to get a second pair of eyes. These pages don't have to be brought up to date with the latest changes, but it would be nice not to have any typos nor anything really incorrect. Just check the box on the page when you've had a look.

Currently these pages are in the danielvf/newdocs branch, though that may go to master any time.

Stan

  • [ ] guides/getting_started/contributing.md @wanderingstan
  • [ ] guides/getting_started/getting-started.md @wanderingstan
  • [ ] guides/getting_started/local-development.md @wanderingstan ( I think this should roll into the getting started page, and perhaps use the origin-box)
  • [ ] guides/overview/architecture.md @wanderingstan

Franck

  • [x] guides/concepts/identity.md @franckc
  • [x] software/bridge-server.md @franckc
  • [x] software/event-listener.md @franckc

Nick

  • [ ] guides/concepts/listing.md @nick
  • [ ] guides/concepts/offer.md @nick

Micah

  • [x] guides/index.md @micahalcorn
  • [x] software/index.md @micahalcorn
  • [x] software/dapp.md @micahalcorn
  • [x] software/notification-server.md @micahalcorn
  • [x] reference/index.md @micahalcorn

Natasha

  • [x] reference/origin-js/attestations.md @Natasha08
  • [x] reference/origin-js/marketplace.md @Natasha08
  • [x] reference/origin-js/reviews.md @Natasha08
  • [x] reference/origin-js/users.md @Natasha08
  • [x] reference/protocol/schemas.md @Natasha08

And More

  • [x] software/discovery-server.md @sparrowDom
  • [x] software/faucet.md @cuongdo
  • [x] software/ipfs-proxy.md @tomlinton
P3 docs help wanted htmcss uux

All 4 comments

_Some notes_

Any chance that we can get a sticky footer? 馃懀

guides/index

software/dapp

  • maybe change "visit our DApp on Mainnet" to "visit the Origin Mainnet Beta"
  • GitHub shoould be capitalized

software/notification-server

The whole thing could use a copy scrub, but we'll cross that bridge once the water is flowing.

Great work, @DanielVF! 馃弳

@DanielVF added small addition to discovery-server part... overall documentation looks great 馃

@DanielVF Great job! I updated danielvf/newdocs with the following updates:

  • Put supported languages in alphabetical order
  • Truncate signatures (and others) that were running outside of the example box
  • Some text edits, and removed an offer status duplication

Get Started (newcomers) Could be tagged as 'good first issue' so it will not be hidden when one search for 'good first issues'

https://docs.originprotocol.com/guides/getting_started/local-development.html still relates to develop branch

Was this page helpful?
0 / 5 - 0 ratings

Related issues

micahalcorn picture micahalcorn  路  3Comments

mikeshultz picture mikeshultz  路  5Comments

shahthepro picture shahthepro  路  5Comments

micahalcorn picture micahalcorn  路  6Comments

davecraige picture davecraige  路  9Comments