iov-one / docs Goto Github PK

As seen on queries/examples, there code references to namecoin which does not exist anymore. Related to #42

Docusaurus has a versioning feature that we will need to use for sure. After being sure that all the documents are up to date with weave (current latest version: v0.20.0), enable versioning and set the version to 0.20.0 for weave.

Recently cron tasks have been implemented. Document how it works and usage in app. And check if weave/design documentation for ticker is sufficient enough.

https://github.com/iov-one/weave/blob/master/gconf/doc.go

Weave decorator is an important concept in the framework. Explain and document it in detail.

• related PR for more info: iov-one/weave-starter-kit#23

https://docs.iov.one/docs/weave/tutorial/domain

@ethanfrey explained the key points about prototool and protobuf on iov-one/weave-starter-kit#23. Document these points to solidify the concept on readers minds.

https://github.com/iov-one/weave/blob/master/cmd/bnsd/client/testdata/genesis_json.md has great documentation of genesis_json

We need to have a way to interact easily with the blockchain app without any kind of boilerplate code. Could we create a test developper module in iov-core where you just import the protobuff definition and then you can query or send message from Neuma to the blockchain app.

If not, you need to explain how to interact to the blockchain app

I moved readthedocs/weave without any change in the content. We need to be sure everything is up to date with weave latest version.

https://docs.iov.one/docs/weave/configuration/application has references to mycoind and bns. Document this to latest version

tendermint init --home ~/.mycoind
mycoind init CASH bech32:tiov1qrw95py2x7fzjw25euuqlj6dq6t0jahe7rh8wp

on https://docs.iov.one/docs/weave/welcome#configuring-your-blockchain page there is this reference to initializing weave app. Need to change this to blog
#132

Guide for this document:
https://github.com/cosmostation/cosmostation-mobile

Goal:
To show what our partners need to do to build a send IOV Token transaction and serializing with Protobuf and give an example with a send transaction with Swift.

• a separate page is created on docs.iov.one for Mobile iOS (Swift)

On docs/weave/design/queries, ResponseQuery changed on latest tendermint version. Update it accordingly. Related to #42

https://docs.iov.one/docs/weave/configuration/tendermint

On https://github.com/iov-one/docs/blob/master/docs/weave/design/03-permissions.md#L145
, there is a bullet point that explains Condition usage but it is not sufficient from the eyes of a new learner of blockchain. This should be improved with elaborating the usage.

https://weave.readthedocs.io/en/latest/index_old.html#weave-architecture has amazing documentation as a tutorial. Move good parts to docs

iov-one/weave#1033 (comment)

Markdown has a cool feature named: Code highligting. There is code highlighting in the docs but their language is not specified. Some of the code does not have a specified language.

here we show codes from the DEX tutorial and also a link; You should show only the blog tutorial

x/amount.go is a great example of extending the functionality, with code like:

// IsPositive returns true if the value is greater than 0
func (a *Amount) IsPositive() bool {
return a.Whole > 0 ||
(a.Whole == 0 && a.Fractional > 0)
}

// IsNegative returns true if the value is less than 0
func (a *Amount) IsNegative() bool {
return a.Whole < 0 ||
(a.Whole == 0 && a.Fractional < 0)
}

We had to deploy validator documentation #14 without a review. Documents need to be refactored

Soon new testnet will be available and then we should update curl command URL links. Such as https://github.com/iov-one/docs/blob/master/docs/weave/weave-api-spec/03-querying.md#L22

As @JimIOV addresses on #80 (comment), State explanation must be improved.

https://docs.iov.one/docs/weave-tutorial/models#validation

This issue resolves #131

no more like and comment in the application

Explanation on addresses is not sufficient enough since a Ledger developer could not understand well how the addresses formatted. Need to write a document explaining the address formats

This description of protool on this page seems optional

https://docs.iov.one/docs/weave-tutorial/codec#prototool

For example for
https://docs.iov.one/docs/weave-tutorial/domain
at the beginning of the doc, provide the reference to
https://github.com/iov-one/blog-tutorial/blob/master/x/blog/codec.proto

https://docs.iov.one/docs/weave/configuration/tendermint and https://docs.iov.one/docs/weave/configuration/validators page is outdated. There is valuable information in the docs, so revisit the docs. Maybe this info could be useful in https://docs.iov.one/docs/iov-name-service/validator/

On Queries page, its mentioned that Merkle proofs are not implemented as of weave v0.14.0. What is the status of the feature? If it is implemented can you point me to the code?
Related to #42

Add https://weave.iov.one/docs/weave/weave-api-spec/protoc-generation-spec to docs.iov.one after "How to sign transactions" under the title "How to generate proto code" or similar.

Consider adding a brief explanation of why someone would want to use proto code to the introduction, ie native mobile apps need to use proto code.

Reference: iov-one/docs-weave-sdk#3

https://docs.iov.one/docs/weave/configuration/validators

Document metadata issue mentioned by @husio in #167 (comment)

Guide for this document:
https://github.com/cosmostation/cosmostation-mobile

Goal:
To show what our partners need to do to build a send IOV Token transaction and serializing with Protobuf and give an example with a send transaction with Java.

• a separate page is created on docs.iov.one for Mobile Android (Java)

Apparently, bucket names must be lower case and between 3-10 characters.
var isBucketName = regexp.MustCompile(`^[a-z_]{3,10}$`).MatchString
Document this in buckets section

Data consistency must be enforced on buckets. All data is validated before saving, but we also need to make sure that all the data corresponds to the correct object type before saving. Let's say you want to. ??

Unfortunately,

Most of the links on weave docs are pointing to either master or v0.19.0. Update all links to refer to the latest tag.

https://docs.iov.one/docs/weave-tutorial/messages#validation

Currently, weave-tutorial/codec is overly complex for a tutorial document. Simplify the document.

On extension page, there is this 2 sentence

IOV weave doesn't just produce a mycoind executable, but was designed from the group up to be extremely flexible for many common use cases. One can easily extend the functionality of mycoind by adding more extensions on top of it, which we do when building the full-fledged bnsd application,`

mycoind module has been removed on one of the latest versions, We need to change references to something else(most likely weave-starter-kit and bnsd)

MacBook-Pro-de-Antoine:blog-tutorial antoineherzog$ blog version
please set in makefile

https://docs.iov.one/docs/weave/tutorial/installation

As can be seen on https://docs.iov.one/docs/weave/configuration/application there are references to mycoind which do not exist anymore. Needs update. Related to #42