layer5io / layer5io/getnighthawk
[Docs] Instructions to build Nighthawk are incomplete
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 162
- Forks
- 127
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
we were notified recently that the instructions on how to build Nighthawk are incomplete.
We are addressing this in the Nighthawk repository in PR#838. How would you like to approach it here. Do we update https://getnighthawk.dev/docs/building-nighthawk/ with a copy of these instructions? Or do we link to the Nighthawk's README? Open to other suggestions of course.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the incomplete instructions at https://getnighthawk.dev/docs/building-nighthawk/ with the Nighthawk README and the approach described in Nighthawk PR#838. First determine whether this repository should duplicate or link to those instructions; done means the build guidance here is complete and consistent with the upstream source.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100