7 Commits

Author SHA1 Message Date
Abin Simon
1c5f3d631d
Update builds docs (#1151)
## Description

Adds more info in the build docs for building corso binary locally or using containers. Also improved docs on building corso container image.

@gmatev let me know if I should add anything else specifically to the docs.

## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 💻 CI/Deployment
- [ ] 🐹 Trivial/Minor

## Issue(s)

<!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. -->
* fixes #684

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-10-13 23:07:59 +00:00
Georgi Matev
fe2516b9ba
Fix all Vale [error] level lint issues and all markdownlint issues (#997)
## Description

* fixes all `markdownlint` issues, includeing autogenerated docs
* fixes [error] level Vale problems 
*
## Type of change

<!--- Please check the type of change your PR introduces: --->
- [ ] 🌻 Feature
- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Test
- [ ] 💻 CI/Deployment
- [x] 🐹 Trivial/Minor

## Issue(s)

## Test Plan

<!-- How will this be tested prior to merging.-->
- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
2022-09-30 07:31:58 +00:00
Georgi Matev
802001513f
Some quality of life docs tooling improvements (#664) 2022-08-26 19:03:36 -07:00
Niraj Tolia
7f82dd5837
Catch typos in docs-related JSON (#66) 2022-05-20 13:22:48 -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
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