Separate internal and user-facing docs (#60)

* Move CLI proposal to internal docs/design location
* Add previously-used headers to CLI design doc
This commit is contained in:
Niraj Tolia 2022-05-20 10:44:39 -07:00 committed by GitHub
parent 71f04fa8d0
commit cab6a515d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 14 deletions

View File

@ -1,8 +1,10 @@
---
title: CLI Proposal
---
# CLI Commands
## Status
Revision: v0.0.1
-----
# 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.

View File

@ -10,9 +10,9 @@ dev:
check:
docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs vale --glob='!**/development/*' docs
-v ${PWD}:/usr/src/docs alcion/docs vale docs
docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore docs/development
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/
shell:
docker run --rm -it \

View File

@ -1,8 +0,0 @@
{
"label": "Development",
"position": 3,
"link": {
"type": "generated-index",
"description": "Resources for Corso development."
}
}