Page MenuHomePhabricator
Differential D7131

Add top-level documentation index for serving docs by version
ClosedPublic
Actions

Authored by jasonbcox on Aug 4 2020, 20:06.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Project
Commits
rABCWEB089f3d4e14ca: Add top-level documentation index for serving docs by version
Summary

This patch adds a top-level index for /doc and reduces
a click for navigating to any particular doc version.

Currently, the only versioned docs are the RPC docs, so the links
point to those directly.

The heading font sizes needed to be adjusted because they do not display well as-is.

Depends on D7130

Test Plan
make serve

Navigate to http://localhost:4000/doc/

Also navigate around the site and make sure the css changes do not cause
any issues.

Diff Detail

Repository
rABCWEB Bitcoin ABC Website
Branch
doc-index
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 12309
Build 24815: arc lint + arc unit

Event Timeline

jasonbcox created this revision.Aug 4 2020, 20:06
Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 4 2020, 20:06
jasonbcox requested review of this revision.Aug 4 2020, 20:06
Harbormaster completed remote builds in B12306: Diff 22741.Aug 4 2020, 20:06
jasonbcox added inline comments.Aug 4 2020, 20:08
css/main.css
515 ↗(On Diff #22741)

This part either doesn't do what it claims or is unused. I tested on multiple screen sizes and the headings are not impacted.

Ideally, we'd set font size based on screen size and/or ratio. That can come in a future diff.

jasonbcox planned changes to this revision.Aug 5 2020, 00:02
jasonbcox updated this revision to Diff 22745.Aug 5 2020, 00:52

Use the new generator to create the index

Harbormaster completed remote builds in B12309: Diff 22745.Aug 5 2020, 00:52
deadalnix accepted this revision.Aug 8 2020, 12:24
This revision is now accepted and ready to land.Aug 8 2020, 12:24
Closed by commit rABCWEB089f3d4e14ca: Add top-level documentation index for serving docs by version (authored by jasonbcox). · Explain WhyAug 10 2020, 15:33
This revision was automatically updated to reflect the committed changes.
jasonbcox added a commit: rABCWEB089f3d4e14ca: Add top-level documentation index for serving docs by version.
jasonbcox mentioned this in D7179: Fix permalink in top-level doc index.Aug 10 2020, 16:18
jasonbcox mentioned this in D6596: [RPC docs] Remove unused index files.Aug 10 2020, 22:08
jasonbcox mentioned this in rABCWEB7e4711cc515c: Fix permalink in top-level doc index.Aug 11 2020, 16:11
jasonbcox mentioned this in rABC148c4f7f071e: [RPC docs] Remove unused index files.Aug 13 2020, 22:23
jasonbcox mentioned this in D7192: Cleanup debug output in RPC index generator.Aug 14 2020, 20:44
jasonbcox mentioned this in rABCWEB329fc5dba092: Cleanup debug output in RPC index generator.Aug 17 2020, 16:24

Revision Contents
Changeset List

PathSize
_layouts/
17 lines
_plugins/
22 lines
css/
8 lines

Diff 22745

View Options

_layouts/docindex.html

Loading...
View Options

_plugins/doc-index-generator.rb

Loading...
View Options

css/main.css

Loading...