Expand DEVELOPMENT proxy section #192
Conversation
xla
requested review from
rudolfs,
garbados,
sarahscott,
NunoAlexandre and
MeBrei
Co-Authored-By: Rūdolfs Ošiņš <[email protected]>
| yarn prettier:check # Check UI code formatting | ||
| yarn prettier:write # Auto-format UI code | ||
| yarn lint # Check UI code for linting errors | ||
| ``` |
There was a problem hiding this comment.
We also have a bunch of helper scripts for the proxy in our package.json, should we maybe include those here too with proper descriptions?
proxy:build # cd proxy && cargo build --all-features --all-targets
proxy:build:release # cd proxy && cargo build --release --all-features --all-targets
proxy:build:test # cd proxy && cargo test --no-run
proxy:start # cd proxy && cargo run --release -- --registry=emulator
proxy:start:test # cd proxy && cargo run -- --registry=emulator --test
There was a problem hiding this comment.
Generally I find these outputs of cli options to be prone to quickly get outdated. I'd rather show a command which shows all the commands.
There was a problem hiding this comment.
I know what you mean. This section expands a bit on the commands however. It's meant to explain when they should be used. As the yarn run command can only show the commands themselves, but there is no way to inline documentation in package.json.
I just provided the # cd proxy && cargo run comments as a reference, the idea was that you'd write the explanation in a comment...
Co-Authored-By: Merle Breitkreuz <[email protected]> Co-Authored-By: Rūdolfs Ošiņš <[email protected]>
Closes #191 * Correct flag * Apply suggestions from @rudolfs Co-Authored-By: Rūdolfs Ošiņš <[email protected]> * Apply suggestions from code review Co-Authored-By: Merle Breitkreuz <[email protected]> Co-Authored-By: Rūdolfs Ošiņš <[email protected]> * Link downstream protocol projects * Improve languag * Correct position of test disclaimerj * Add proxy commands with explanations * Address feedback Co-authored-by: Rūdolfs Ošiņš <[email protected]> Co-authored-by: Merle Breitkreuz <[email protected]>
Closes #191