Adding start-docs command and readme improvements
#2997
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #2997 +/- ##
=======================================
Coverage 75.03% 75.03%
=======================================
Files 240 240
Lines 19116 19116
Branches 4312 4312
=======================================
Hits 14343 14343
Misses 4773 4773 ☔ View full report in Codecov by Sentry. |
SnailBones
changed the title
start-docs command and reademe improvementsstart-docs command and readme improvements
|
Thanks @HarelM! |
package.json
Outdated
| @@ -146,6 +146,7 @@ | |||
| "generate-style-code": "npm run tsnode build/generate-style-code.ts", | |||
| "generate-typings": "npm run tsnode build/generate-typings.ts", | |||
| "generate-docs": "typedoc && npm run tsnode build/generate-docs.ts", | |||
| "start-docs": "docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material", | |||
There was a problem hiding this comment.
Can you move this command down to the start commands and keep this section for the generate commands?
documents_and_diagrams/README.md
Outdated
|
|
||
| ## Setting up Docker access | ||
|
|
||
| Before you can run the docs, you need to ensure that you can run `docker` commands without `sudo`: |
There was a problem hiding this comment.
I would consider linking to an article here in the docker docs or something, as this is not specific to this project.
documents_and_diagrams/README.md
Outdated
|
|
||
| ```bash | ||
| npm run start-docs | ||
| ``` |
There was a problem hiding this comment.
This is great, I would consider adding a note on how to update the docs while editing, i.e. keep the start-docs running and re run generate-docs to see the changes.
|
Thanks for the review @HarelM! Just addressed your three suggestions. |
|
Thanks!! |
Launch Checklist
CHANGELOG.mdunder the## mainsection.