ignite / cli

Ignite is a CLI tool and hub designed for constructing Proof of Stake Blockchains rooted in Cosmos-SDK
https://ignite.com
Other
1.26k stars 547 forks source link

can we make intro the docs landing page instead of docs README? #1034

Closed barriebyron closed 3 years ago

barriebyron commented 3 years ago

I missed this hijack of the docs README when the docs got published to the web.

I see what's happening now, so I have a request. Instead of having the docs README serve as the docs landing page, can we instead use https://docs.starport.network/intro/intro.html?

Then we use the docs/README as a general repo description, like https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md

fadeev commented 3 years ago

I don't think this is something we can do: index page points to the readme at the top-level and solutions that circumvent this will probably be hacky.

What I'm thinking we can do is move all content from intro.md into the readme and have a general repo description in a separate MD file in extra, for example, if it should be published on the website OR if it shouldn't, we can just create a contributing.md at the top-level.

@barriebyron please, lmk if you think this is a good solution.

barriebyron commented 3 years ago

I probably need to understand a bit more. I put a link to the Starport repo in the Cosmos SDK README https://github.com/cosmos/cosmos-sdk/pull/9181/files

fadeev commented 3 years ago

@barriebyron looks good, thanks!