Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Missing how-to guides + docs setup #588

Merged
merged 10 commits into from
Nov 9, 2019
Merged

Missing how-to guides + docs setup #588

merged 10 commits into from
Nov 9, 2019

Conversation

dskvr
Copy link
Contributor

@dskvr dskvr commented Sep 5, 2019 •
edited
Loading

Change Description

Add a number of missing how-to guides, missing documents and prepare documentation format for production.

Overview Documents

  • Introduction
  • Technical Overview
  • Installation

Troubleshooting

  • Connectivity
  • [ ] Missing Authorizations

Faq (should probably be a singular document containing several FAQ)

  • What is a signature provider?
  • Example signature providers (does this belong here @sjkelleyjr ?)

Basic Usage Docs

  • In a Browser
  • Commonjs
  • ESM

How to Guides

  • How to get block info
  • How to submit a transaciton
  • How to get transaction information
  • How to create an account
  • How to get account information
  • How to deploy a smart contract
  • How to get table information
  • How to transfer an EOSIO token
  • How to link permissions
  • How to unlink permissions
  • How to stake
  • How to unstake
  • How to sign a multisig transaction
  • How to vote
  • How to set the target blockchain

API Changes

  • API Changes

Documentation Additions

  • Documentation Additions

@dskvr dskvr added the docs label Sep 5, 2019
Sandwich and others added 4 commits September 5, 2019 14:37
@tbfleming
Copy link
Contributor

@sjkelleyjr I love the how-to guides; they cover questions people keep asking.

02_how-to-get-transaction-information.md needs to mention that history_get_transaction uses /v1/history/get_transaction, which is deprecated.

This was referenced Sep 20, 2019
Closed
Closed
Open
@sjkelleyjr
adding deprecation notice to get transaction how-to, re-wording how-t…
9161eab 
…o-submit-a-transaction and adding the troubleshooting docs
@dskvr dskvr requested a review from c0d3ster September 23, 2019 10:31
@sjkelleyjr
fixing small typos/filename formatting, adding the introduction and t…
af1dc82 
…echnical overview content, as well as the signature provider and list of signature providers content.
@dskvr dskvr requested a review from GreenBusDriver October 17, 2019 17:38
@GreenBusDriver
Copy link
Contributor

Todd and I have completed our review. Just 2 comments. This is great. 🚢

@GreenBusDriver GreenBusDriver marked this pull request as ready for review October 22, 2019 02:45
GreenBusDriver
GreenBusDriver approved these changes Oct 22, 2019
View reviewed changes
Copy link
Contributor

@GreenBusDriver GreenBusDriver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. cTodd and I have both reviewed this.

@dskvr dskvr merged commit af47366 into develop Nov 9, 2019
@dskvr dskvr deleted the docs/starter branch November 9, 2019 05:40
@lparisc lparisc added documentation Requires attention of documentation team. e.g. documentation is expected to be generated. and removed docs labels Mar 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@GreenBusDriver GreenBusDriver GreenBusDriver approved these changes

@c0d3ster c0d3ster Awaiting requested review from c0d3ster

Assignees

@sjkelleyjr sjkelleyjr

Labels
documentation Requires attention of documentation team. e.g. documentation is expected to be generated.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dskvr @tbfleming @GreenBusDriver @lparisc @sjkelleyjr