boyney123 / boyney123/status-checks-docs

Exposing localhost

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

You currently recommend ngrok or inlets at https://status-checks.netlify.com/docs/getting-started/setup#exposing-localhost-for-github

We used ngrok in the past to expose localhost for Probot, but we had plenty of problems with it. Eventually the team created https://smee.io/ which works extremely well, and it’s fairly easy to integrate, check it out :)

The additional benefit is that folks can have the https://smee.io/random-id-here page open in their browser for debugging purposes

Contributor guide

Open the contributing guide

Research direction

Start with the setup documentation at the linked “exposing localhost for GitHub” section and inspect how ngrok or inlets are currently recommended. Update the guidance to cover smee.io and its browser-based debugging benefit; done means the setup page accurately explains the new recommendation.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.