chore: collapse module spec and readme

[alexanderbez]

Description

closes: #6779

• Move spec into single readme
• Perform some cleanup (e.g. params, etc...)

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• updated the relevant documentation or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage
• manually tested (if applicable)

[julienrbrt]

Don't we do all modules in one PR? You need to modify this file too, so it points to the right README: https://raw.githubusercontent.com/cosmos/cosmos-sdk/ccdc355eea4eecac72395b7660b757ca45d394f1/x/README.md.
Which means you'll need to update https://github.com/cosmos/cosmos-sdk/blob/main/docs/pre.sh.

I think we should do all modules together: otherwise they won't appear anymore on docs.cosmos.network till pre.sh is updated.

[alexanderbez]

Don't we do all modules in one PR?

No, that would be too much for one author.

I think we should do all modules together: otherwise they won't appear anymore on docs.cosmos.network till pre.sh is updated.

How? This is on main. I'd be shocked if docs.cosmos.network displays docs based off of main and not the latest release.

[julienrbrt]

Don't we do all modules in one PR?

No, that would be too much for one author.

I think we should do all modules together: otherwise they won't appear anymore on docs.cosmos.network till pre.sh is updated.

How? This is on main. I'd be shocked if docs.cosmos.network displays docs based off of main and not the latest

It will still appear in releases, but for those who bookmarked /main, the bank module spec will be broken.

[tac0turtle]

lets do all in one, its not a heavy lift

[alexanderbez]

We can do all in one, sure. But I still fail to see what this has to do with the webapp for displaying docs.

[alexanderbez]

@marbar3778 can you comment on what modules you will take care of so I can do the rest, please?

[julienrbrt]

I picked up the rest. Now improving pre.sh so we can keep the same page split because:

previous:

current:

Btw x/genutil and x/simulation have no docs at all (as README I mean, but they have a doc.go, do we want to copy that content into a REAMDE?).

[julienrbrt]

We can do all in one, sure. But I still fail to see what this has to do with the webapp for displaying docs.

This is because we build the docs based on the /spec of each module. So, the logic for building the docs needs to change if we remove the /spec folder.

[tac0turtle]

I picked up the rest. Now improving pre.sh so we can keep the same page split because:

previous:

current:

Btw x/genutil and x/simulation have no docs at all (as README I mean, but they have a doc.go, do we want to copy that content into a REAMDE?).

this is the left menu, what about the right menu?

[julienrbrt]

this is the left menu, what about the right menu?

The right menu is awful because all headers show the same with one big file. So, you don't really see the page structure at all.
It would be great if our vuepress would behave like osmosis's. Then won't need that file splitting.

Fixed now :)

[alexanderbez]

Wow, you guys are amazing. Thank you for the hard work 👏