peng/fix docs base directory #2295
Conversation
nylira
requested review from
ebuchman,
melekes,
xla and
zramsay
as code owners
| @@ -2,23 +2,21 @@ module.exports = { | |||
| title: "Tendermint Core", | |||
| description: "Documentation for Tendermint Core", | |||
| dest: "./dist/docs", | |||
| base: "/", | |||
| base: "/docs/", | |||
There was a problem hiding this comment.
Should we also remove this prefix from links in .md files?
There was a problem hiding this comment.
@faboweb I don't think that's necessary, right?
There was a problem hiding this comment.
can you point me to an example on the website?
There was a problem hiding this comment.
@melekes this base: "/docs/" refers to the documentation website being run under a subdirectory of the Tendermint website. I do believe there are links that need to be fixed in the Tendermint docs to ensure they work on the docs website. But that probably belongs in a different PR (@jb @zramsay are the ones who would know more). This PR is a high priority merge for develop and master. @greg-szabo
There was a problem hiding this comment.
Seems theres a few docs related things on develop that aren't on master. Can we get a separate PR against master that just copies these over, or at least whatever parts we need?
There was a problem hiding this comment.
Can we get someone assigned to this?
CHANGELOG_PENDING.md
Outdated
| @@ -26,6 +26,7 @@ FEATURES: | |||
|
|
|||
| IMPROVEMENTS: | |||
| - [docs] Lint documentation with `write-good` and `stop-words`. | |||
| - [docs] Fix base directory of documentation website. | |||
There was a problem hiding this comment.
no need in changelog entry
Codecov Report
@@ Coverage Diff @@
## develop #2295 +/- ##
===========================================
- Coverage 60.92% 60.89% -0.03%
===========================================
Files 196 196
Lines 16173 16166 -7
===========================================
- Hits 9853 9844 -9
+ Misses 5464 5463 -1
- Partials 856 859 +3
|
This is a mirror of this PR cosmos/cosmos-sdk#2174, which fixes the root directory and rendering of the documentation website (tendermint.com/docs).