Cosmos-sdk: Document Module Tags

[rigelrozanski]

Description

As An SDK app developer
I Want consult per-module godoc documentation and learn more about module tags
So That I can reuse SDK module tags in my application.

ToDo: add a reference to the tags section of the spec on each x/<module>/tags package godoc description

Acceptance Criteria

AC1

Given a SDK module ABC
When I browse https://godoc.org/github.com/cosmos/cosmos-sdk/x/ABC/tags
Then I can access tags documentation via a reference to https://cosmos.network/docs/clients/

References

• http://elliot.land/post/godoc-tips-tricks

[fedekunze]

@rigelrozanski is this resolved for the gov module only ?

[rigelrozanski]

As far as I understand there is not centralized documentation of these tags yet. I would recommend that the tag documentation go into docs/spec/tags

[fedekunze]

@rigelrozanski what would be the structure for the documentation, just list and group tags by module ? Any other considerations ?

[rigelrozanski]

Nope I think you got it! - that sounds like it

Maybe a short description beside each tag too

[fedekunze]

Let's put this into high priority, seems it's not well documented, see (#3990 discussion). cc: @jackzampolin @sabau @gamarin2 @alexanderbez

[sabau]

Totally, as a client developer it takes time to understand what you can query, would be great to have it either on swagger or somewhere else if that's too verbose

[yangyanqing]

Can I join this group to improve the documents?

[gamarin2]

I think it would be a great fit in https://github.com/cosmos/cosmos-sdk/tree/develop/docs/clients.

@yangyanqing Do you mean you want to help write this document?

[alexanderbez]

Note, I've started this already in docs. Each module spec should have a tags section (e.g. https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/staking/06_tags.md).

[gamarin2]

Note, I've started this already in docs. Each module spec should have a tags section (e.g. https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/staking/06_tags.md).

Sure thanks! I still think it'd be nice to have a general section that explains what tags are, give more context around them + give a list of references to each module tag section

[yangyanqing]

English isn't my mother language, so I don't know if I can write idiomatic doc. But I can translate doc into Chinese or do some coding such as generating swagger file automaticly in #3011. @gamarin2

[alessio]

Why don't we turn all the specs into the go doc format? I'd be much easier to maintain docs if they lived along with the code. I'm attaching an example.

bank.zip

[sabau]

I actually like @alessio proposal, if they live together it's quicker for us to notice is something is off-place, or and when we change them, do the changes in one place

[fedekunze]

We agreed on the call that we'll update them on the docs and add a reference to it on each tags package godoc description

[jackzampolin]

I think we have added these docs. Closing