From 930d9bd13240eb906c3abfacb232315f94c5cc7e Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Thu, 19 May 2022 16:27:01 -0700 Subject: [PATCH] Internal docs (#58) * Move CLI abstract * Add docs index for Corso dev resources * Tweak CLI proposal title --- docs/.vale.ini | 2 +- docs/Makefile | 4 ++-- docs/docs/development/_category_.json | 8 ++++++++ docs/docs/{ => development}/cli.md | 4 ++-- docs/docusaurus.config.js | 6 ------ 5 files changed, 13 insertions(+), 11 deletions(-) create mode 100644 docs/docs/development/_category_.json rename docs/docs/{ => development}/cli.md (99%) diff --git a/docs/.vale.ini b/docs/.vale.ini index 507fb6152..90bea5b32 100644 --- a/docs/.vale.ini +++ b/docs/.vale.ini @@ -5,5 +5,5 @@ Vocab = Base Packages = Microsoft, proselint, write-good, alex, readability -[*] +[*.md] BasedOnStyles = Vale, Microsoft, proselint, write-good, alex, readability diff --git a/docs/Makefile b/docs/Makefile index a17538f1d..c299d1e4a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,9 +10,9 @@ dev: check: docker run --rm \ - -v ${PWD}:/usr/src/docs alcion/docs vale --glob='docs/**/*.md' . + -v ${PWD}:/usr/src/docs alcion/docs vale --glob='!**/development/*' docs docker run --rm \ - -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ + -v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore docs/development shell: docker run --rm -it \ diff --git a/docs/docs/development/_category_.json b/docs/docs/development/_category_.json new file mode 100644 index 000000000..415898626 --- /dev/null +++ b/docs/docs/development/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Development", + "position": 3, + "link": { + "type": "generated-index", + "description": "Resources for Corso development." + } +} diff --git a/docs/docs/cli.md b/docs/docs/development/cli.md similarity index 99% rename from docs/docs/cli.md rename to docs/docs/development/cli.md index 7bf3a8c42..6d3d64051 100644 --- a/docs/docs/cli.md +++ b/docs/docs/development/cli.md @@ -1,8 +1,8 @@ --- -title: CLI +title: CLI Proposal --- -# Abstract +# Corso CLI Proposal This is a proposal for Corso cli commands extrapolated from the Functional Requirements product documentation. Open questions are listed in the `Details & Discussion` section. The command set includes some p1/p2 actions for completeness. This proposal only intends to describe the available commands themselves and does not evaluate functionality or feature design beyond that goal. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 1625b61d3..1cdb1f38e 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -58,12 +58,6 @@ const config = { src: 'img/corso.svg', }, items: [ - { - type: 'doc', - docId: 'cli', - position: 'left', - label: 'CLI', - }, { type: 'doc', docId: 'intro',