Internal docs (#58)
* Move CLI abstract * Add docs index for Corso dev resources * Tweak CLI proposal title
This commit is contained in:
parent
5f8d040b40
commit
930d9bd132
@ -5,5 +5,5 @@ Vocab = Base
|
||||
|
||||
Packages = Microsoft, proselint, write-good, alex, readability
|
||||
|
||||
[*]
|
||||
[*.md]
|
||||
BasedOnStyles = Vale, Microsoft, proselint, write-good, alex, readability
|
||||
|
||||
@ -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 \
|
||||
|
||||
8
docs/docs/development/_category_.json
Normal file
8
docs/docs/development/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Development",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Resources for Corso development."
|
||||
}
|
||||
}
|
||||
@ -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.
|
||||
|
||||
@ -58,12 +58,6 @@ const config = {
|
||||
src: 'img/corso.svg',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'cli',
|
||||
position: 'left',
|
||||
label: 'CLI',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'intro',
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user