From 974fb7fc07d55cab301d46fabc5abab3abf27685 Mon Sep 17 00:00:00 2001 From: sean billig Date: Sat, 28 Mar 2020 11:34:04 -0700 Subject: [PATCH] minor doc fixes; add gh cli instructions --- docs/architecture.md | 2 +- docs/contributing.md | 2 +- docs/maintaining.md | 7 +++++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index db4e8e6..d70d27d 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -54,7 +54,7 @@ require("./foobar/index.js"); // excessive specificity **Note:** I want to make _very_ clear that this is an experiment, not a claim that this is Objectively Better. -### Any my [hyper]axe +### And my [hyper]axe Converting JSON data to HTML templates is hard work. I started with Swig but when I realized it wasn't maintained I rewrote everything in EJS. I liked it a diff --git a/docs/contributing.md b/docs/contributing.md index 4567f4b..fd19edf 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,6 +1,6 @@ # Contributing -If you want to dive into the details, please see the [contract](./contract) +If you want to dive into the details, please see the [contract](./contract.md) that defines the contributor role in this project. If you're comfortable with a top-level summary, you can start here first. diff --git a/docs/maintaining.md b/docs/maintaining.md index c7d0979..2dde9bc 100644 --- a/docs/maintaining.md +++ b/docs/maintaining.md @@ -26,3 +26,10 @@ npm ci && npm test && npm start ``` No need to add their fork as a remote. + +Or for ultimate convenience (and github lock-in), use the [github cli tool](https://cli.github.com): + +```sh +gh pr list +gh pr checkout 42 +```