11 Commits

Author SHA1 Message Date
Niraj Tolia
cab6a515d9
Separate internal and user-facing docs (#60)
* Move CLI proposal to internal docs/design location
* Add previously-used headers to CLI design doc
2022-05-20 10:44:39 -07:00
Niraj Tolia
71f04fa8d0
Tweak config settings and apply Corso docs fixes (#59)
- Disable the readability style checker for now
- Remove all errors and warnings with the fixed Vale globbing
- Rename template directory
2022-05-20 10:28:40 -07:00
Niraj Tolia
930d9bd132
Internal docs (#58)
* Move CLI abstract
* Add docs index for Corso dev resources
* Tweak CLI proposal title
2022-05-19 16:27:01 -07:00
Keepers
5f8d040b40
adds docs/CLI.md (#28)
* adds docs/CLI.md

Introduces the cli command documentation.

* extending cli.md with design discussion

* migrate cli.md into docusaurus docs (#11)

Move the CLI.md file into docusaurus so that it appears
as part of the documentation page.

* remove cli version, settings.json (#11)

Remove /.vscode/settings.json and the versioning info from
/docs/cli.md.
2022-05-19 16:08:01 -06:00
Niraj Tolia
c3c3613a71
Docs: Allow for a clean run of make check (#57) 2022-05-19 14:32:30 -07:00
Niraj Tolia
49aa63c349
Remove sample docs (#56) 2022-05-19 13:32:03 -07:00
Niraj Tolia
b903d962d3
Add Markdown linting (#52)
- Also renames `make vale` to `make check`
- Addresses a part of #15
2022-05-19 10:45:31 -07:00
Niraj Tolia
5f7f5736ed
Add docs and commands to setup the container image (#49) 2022-05-19 10:29:25 -07:00
Niraj Tolia
038d94b818
Add Vale linting to docs (#47)
* Add vale to docs build image

* Add Vale config and style guides

* Add Vale to Makefile
2022-05-18 14:45:25 -07:00
Niraj Tolia
8812f4bc9b
Customize options for Corso (#48)
Uses a Noun project icon for now. Color #776A60 used with
https://thenounproject.com/icon/cane-corso-4559376/

Co-authored-by: Vaibhav Kamra <vkamra@alcion.ai>
2022-05-18 14:22:38 -07:00
Niraj Tolia
ad15968837
Add docs template (#40)
* Add Dockerfile and Makefile for docs

* New Docusaurus project

* Remove blog from docs

* Add missing package-lock.json

* .PHONY
2022-05-16 22:44:49 -07:00