Skip to content

Update Docs #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Viijay-Kr opened this issue Mar 13, 2025 · 3 comments
Open

Update Docs #575

Viijay-Kr opened this issue Mar 13, 2025 · 3 comments

Comments

@Viijay-Kr
Copy link

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
@jakebailey
Copy link
Member

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

@Viijay-Kr
Copy link
Author

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

@jakebailey
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants