Cosmos-sdk: Should docs links include master?

Created on 12 Mar 2020  Â·  3Comments  Â·  Source: cosmos/cosmos-sdk

Summary of Bug

I'm always confused why docs links don't work and then when I find the correct page I realize it was right all along but just missing the /master/ section of the URL. I'm still confused though, is that supposed to be there? Is it supposed to work regardless? How can we ensure that it is actually pointing to the correct one? I know we have 404 checkers but the docs seem to be built in a way that they don't trigger 404s, maybe because they're rendered in the browser?

The case that I encountered recently is this page:
https://docs.cosmos.network/master/core/context.html#context-definition
If you click ABCI Header link it takes you to: https://tendermint.com/docs/spec/abci/abci.html#header
But this should actually be to: https://docs.tendermint.com/master/spec/abci/abci.html#header
Instead it fails "gracefully" and takes you to: https://docs.tendermint.com/master/spec/
(Which includes /master/! lol)
What is it supposed to be?

Version

Steps to Reproduce


For Admin Use

  • [ ] Not duplicate issue
  • [ ] Appropriate labels applied
  • [ ] Appropriate contributors tagged
  • [ ] Contributor assigned/self-assigned
docs

Most helpful comment

You're amazing Denis 🙌

All 3 comments

Yes, docs links should contain /master/ after domain name. The reason the header link doesn't work as expected is because it points to the old location of Tendermint docs: https://tendermint.com/docs/. Since the docs had moved to https://docs.tendermint.com the old link redirects to the Tendermint website, from which we route to the correct (or in this case, incorrect) page.

I'll add a rule to the tendermint.com router to redirect from https://tendermint.com/docs/spec/abci/abci.html to https://docs.tendermint.com/master/spec/abci/abci.html#header

Okay, I've added a redirect for all /docs/* URLs. That should fix this issue. I'll also add the same to cosmos.network. Let me know if I can do anything else here 🙂

You're amazing Denis 🙌

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ValarDragon picture ValarDragon  Â·  3Comments

rigelrozanski picture rigelrozanski  Â·  3Comments

ValarDragon picture ValarDragon  Â·  3Comments

ValarDragon picture ValarDragon  Â·  3Comments

adrianbrink picture adrianbrink  Â·  3Comments