typescript-go icon indicating copy to clipboard operation
typescript-go copied to clipboard

Update Docs

Open Viijay-Kr opened this issue 9 months ago • 3 comments

Right now the docs does include hereby commands to build , lint etc.

However instead of

hereby build
...

would be great to have

npx hereby build

Viijay-Kr avatar Mar 13 '25 17:03 Viijay-Kr

Most of us have hereby installed globally as that's faster to run, but, I guess we could document it differently.

jakebailey avatar Mar 13 '25 18:03 jakebailey

I'd agree. Although it would be even better if hereby is kept as dev dependency and npm scripts can use it and docs say npm run build etc.

The doc says hereby is not needed to work on the repo but it is actually a dependency. Just a misled information. I m sure you have ton of things to worry about besides this trivial one. I'd be happy to submit a PR

Viijay-Kr avatar Mar 13 '25 18:03 Viijay-Kr

We already have scripts for some tasks, and could include more.

The doc says hereby is not needed to work on the repo but it is actually a dependency. Just a misled information.

This depends on what you mean by "work". You can clone the repo and work straight away with just go test; anything else is extra.

jakebailey avatar Mar 13 '25 18:03 jakebailey