Skip to content

kosli-dev/cli-docs-spike

Repository files navigation

Spike of Kosli CLI documentation idea.
Hovering over content highlights and auto-scrolls related/explanatory content in other dom elements into view.

  • Top section is a Trails .kosli.yml template file (lhs) and pane for commentary (rhs)
    Screenshot
  • Middle section is crude mock-up of Trail Attestations on a horizontal "washing line" Screenshot
  • Bottom section is Github Actions .yml workflow (lhs) and pane for commentary (rhs) Screenshot

Notes:

  • The lhs yml file views are generated from actual yml files.
  • Has minimal CSS styling.
  • Has almost no commentary in the rhs panes yet (only lorem ipsum except for dashboard.lint).
  • Has left->right and right->left auto-scrolling, maybe just right->left?

To try it out (requires docker, docker-compose, bash):

git clone git@github.com:kosli-dev/cli-docs-spike.git
cd cli-docs-spike
source scripts/shortcuts.sh
d

If port 80 is available, an html page will load in your default browser.