Docs theme by fadeev · Pull Request #4042 · tendermint/tendermint

fadeev · 2019-10-07T17:10:39Z

This PR includes an updated documentation theme.

To test it out run cd docs && npm install && npm run serve, or visit http://tendermint-docs.surge.sh/

Features such as search, definition tooltips and language switcher will be added incrementally.

fadeev · 2019-10-07T17:16:49Z

Since sidebar is generated automatically, it is very possible that it looks not the way we want it to. Please, report what needs to be changed, and I will either modify the script or propose changes to the directory structure (sidebar displays only two levels of dirs).

melekes · 2019-10-07T20:19:13Z

love it ❤️

One note: Help & Support section does not make sense to me. The riot channel for Tendermint is https://riot.im/app/#/room/#tendermint:matrix.org. Forum link: https://forum.cosmos.network/c/tendermint. Help & Support and footer both look like from cosmos project. Maybe we should tailor it for Tendermint?

fadeev · 2019-10-07T21:07:26Z

@melekes thanks! Absolutely, i'll make it configurable.

codecov-io · 2019-10-08T11:27:53Z

Codecov Report

Merging #4042 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4042      +/-   ##
==========================================
+ Coverage   67.12%   67.12%   +<.01%     
==========================================
  Files         245      245              
  Lines       20575    20580       +5     
==========================================
+ Hits        13811    13815       +4     
+ Misses       5729     5726       -3     
- Partials     1035     1039       +4

Impacted Files	Coverage Δ
privval/signer_server.go	`95.65% <0%> (-4.35%)`	⬇️
privval/signer_endpoint.go	`81.33% <0%> (-2.67%)`	⬇️
blockchain/v0/reactor.go	`80.66% <0%> (-0.95%)`	⬇️
consensus/replay.go	`70.96% <0%> (-0.81%)`	⬇️
consensus/reactor.go	`77.49% <0%> (-0.36%)`	⬇️
blockchain/v0/pool.go	`82.62% <0%> (-0.33%)`	⬇️
state/validation.go	`84.48% <0%> (+2.3%)`	⬆️
libs/flowrate/util.go	`66.66% <0%> (+6.66%)`	⬆️
blockchain/v2/reactor.go	`66.66% <0%> (+10.52%)`	⬆️

docs/dev_sessions/DEV_SESSIONS.md

fadeev · 2019-10-08T14:12:25Z

Made changes to the script, so specs should show up in the sidebar (for example, ABCI spec). Only {{spec_name}}/readme.md shows up, because we have a two-level hierarchy. According to design each spec should have it's contents (files, other than readme) displayed as cards inside the content area. I'm working on it.

fadeev · 2019-10-08T14:16:01Z

One more thing. Since this repo depends on npm's vuepress-theme-cosmos, it doesn't hurt to do cd docs && rm -rf node_modules && npm install --save vuepress-theme-cosmos to get the latest theme files.

fadeev · 2019-10-08T15:35:16Z

Added cards for directory contents. Useful for specs in tendermint and modules in cosmos-sdk. To enable add cards: true in frontmatter (naming is hard, I'm open to suggestions). Descriptions under titles are taken from description property of the corresponding file's frontmatter.

Looks something like this:

fadeev · 2019-10-08T19:06:43Z

fadeev · 2019-10-09T13:11:51Z

Made footer customizable (see config.js), brought back language selector, added very basic search. This is a super naive search, it doesn't represent how a proper search should look or behave like.

tac0turtle · 2019-10-09T13:28:28Z

docs/.vuepress/config.js

+      editLink: true,
+      children: [
+        {
+          title: "Riot Chat",


should these be links?

Yes, I'll make sure these strings are processed with markdown, so we can have links.

sweet with that i think this is ready to be merged

tac0turtle · 2019-10-09T13:40:10Z

docs/spec/rpc/index.html → docs/.vuepress/public/rpc/index.html
docs/spec/rpc/swagger.yaml → docs/.vuepress/public/rpc/swagger.yaml

how come these were moved? I think these should live in the rpc pkg for the time being, and copied into the vuepress folder

fadeev · 2019-10-09T13:51:33Z

@marbar3778 re:rpc VuePress pretty much ignores HTML files outside of public and doesn't include them into the final build directory.

tac0turtle · 2019-10-09T13:52:59Z

VuePress pretty much ignores HTML files outside of public and doesn't include them into the final build directory.

yes, simplest is to copy into vue-press/public before build

fadeev · 2019-10-09T14:06:00Z

@marbar3778 Do you mean to store rpc in docs/rpc and copy it to public as part of build script (and delete afterwards) or to keep it in docs/.vuepress/public/rpc?

tac0turtle · 2019-10-09T14:11:21Z

the first one 😄 just store the swagger files in rpc/swagger folder then before build just copy it over

melekes · 2019-10-09T15:55:51Z

docs/.vuepress/config.js

+  //     lang: "en-US"
+  //   },
+  //   "/ru/": {
+  //     lang: "ru"


currently there is no Russian translation so commented out the options

tac0turtle · 2019-10-11T10:29:56Z

.circleci/config.yml

  version: 2
  test-suite:
    jobs:
-      - deploy_docs:


can we keep this to master? I believe this is what the sdk team talked about.

fadeev added 3 commits October 4, 2019 01:33

docs theme

5064f77

vuepress-theme-cosmos

76f4619

version bump

6e276db

fadeev requested review from ebuchman, melekes and xla as code owners October 7, 2019 17:10

fadeev requested a review from nylira October 7, 2019 17:11

Merge branch 'master' into fadeev/docs-theme

cc90650

tac0turtle added 3 commits October 8, 2019 14:02

changes to docs

5994ad6

more code changes

4b97782

sidebar order fix

74fe703

tac0turtle reviewed Oct 8, 2019

View reviewed changes

docs/dev_sessions/DEV_SESSIONS.md Outdated Show resolved Hide resolved

tac0turtle and others added 4 commits October 8, 2019 14:21

moar changes

bc0ae5b

fixed dev sessions title

e402985

fixed dev sessions title, again

169062a

specs should show up in sidebar

a985d81

fadeev added 2 commits October 8, 2019 17:30

contents cards

c14c181

version bump

cd52dab

fadeev added 2 commits October 8, 2019 20:59

sidebar, rpc

c018541

version bump

20c133e

fadeev added 2 commits October 9, 2019 18:03

custom footer and super naive search

1122477

version

ed172bf

tac0turtle reviewed Oct 9, 2019

View reviewed changes

minor change to vuepress

0e36e23

move swagger file

09ff91a

tac0turtle approved these changes Oct 9, 2019

View reviewed changes

fadeev and others added 2 commits October 9, 2019 20:27

pre and post scripts

a95a2a4

Merge branch 'master' into fadeev/docs-theme

afa0be6

fadeev requested review from milosevic and mircea-c October 9, 2019 15:41

melekes approved these changes Oct 9, 2019

View reviewed changes

build

348ba79

fadeev requested a review from tessr as a code owner October 10, 2019 16:30

changed docs build process

3287bcb

tac0turtle reviewed Oct 11, 2019

View reviewed changes

mircea-c force-pushed the fadeev/docs-theme branch from ea53ace to 2aa6b46 Compare October 11, 2019 14:34

added deployment config

2aa6b46

mircea-c force-pushed the fadeev/docs-theme branch from 354b86a to 364a727 Compare October 11, 2019 15:56

mircea-c and others added 2 commits October 11, 2019 11:56

updated versions file and added deployment filters

364a727

Merge branch 'master' into fadeev/docs-theme

af37d6e

tac0turtle merged commit aaa060f into master Oct 11, 2019

tac0turtle deleted the fadeev/docs-theme branch October 11, 2019 16:07

Conversation

fadeev commented Oct 7, 2019

Uh oh!

fadeev commented Oct 7, 2019

Uh oh!

melekes commented Oct 7, 2019

Uh oh!

fadeev commented Oct 7, 2019

Uh oh!

codecov-io commented Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

fadeev commented Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fadeev commented Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fadeev commented Oct 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fadeev commented Oct 8, 2019

Uh oh!

fadeev commented Oct 9, 2019

Uh oh!

tac0turtle Oct 9, 2019

Choose a reason for hiding this comment

Uh oh!

fadeev Oct 9, 2019

Choose a reason for hiding this comment

Uh oh!

tac0turtle Oct 9, 2019

Choose a reason for hiding this comment

Uh oh!

tac0turtle commented Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fadeev commented Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tac0turtle commented Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fadeev commented Oct 9, 2019

Uh oh!

tac0turtle commented Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melekes Oct 9, 2019

Choose a reason for hiding this comment

Uh oh!

tac0turtle Oct 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tac0turtle Oct 11, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-io commented Oct 8, 2019 •

edited

Loading

fadeev commented Oct 8, 2019 •

edited

Loading

fadeev commented Oct 8, 2019 •

edited

Loading

fadeev commented Oct 8, 2019 •

edited

Loading

tac0turtle commented Oct 9, 2019 •

edited

Loading

fadeev commented Oct 9, 2019 •

edited

Loading

tac0turtle commented Oct 9, 2019 •

edited

Loading

tac0turtle commented Oct 9, 2019 •

edited

Loading

tac0turtle Oct 9, 2019 •

edited

Loading