Skip to content

docs: Fix formatting and add Windows troubleshooting guide#121

Merged
Scottcjn merged 1 commit intoScottcjn:mainfrom
zhangxue1985122219:docs/format-fixes
Mar 5, 2026
Merged

docs: Fix formatting and add Windows troubleshooting guide#121
Scottcjn merged 1 commit intoScottcjn:mainfrom
zhangxue1985122219:docs/format-fixes

Conversation

@zhangxue1985122219
Copy link
Contributor

Changes

This PR improves the README.md documentation with the following changes:

  1. Fix formatting: Remove extra blank line in the Webhook (Internet) section for consistent markdown formatting.

  2. Add Windows troubleshooting: Add detailed instructions for Windows users to add beacon to their PATH:

    • PowerShell commands to add Scripts directory to PATH
    • Command Prompt (CMD) instructions using setx
    • Cross-platform usability improvements

Why this matters

Beacon is now more accessible to Windows users, who previously had no guidance on how to fix the common 'beacon: command not found' error after installation.

Testing

  • Verified markdown renders correctly
  • Windows PATH commands tested on PowerShell 7 and CMD

- Remove extra blank line in Webhook section
- Add detailed Windows PATH setup instructions for PowerShell and CMD
- Improve cross-platform usability for new users
@github-actions github-actions bot added the size/XS PR: 1-10 lines label Mar 5, 2026
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to beacon-skill! Thanks for your first pull request.

Quick checklist:

  • Tests pass (pytest tests/)
  • New code includes SPDX license header
  • Focused on a single change

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100)

A maintainer will review your PR soon!

@Scottcjn Scottcjn merged commit 9141d57 into Scottcjn:main Mar 5, 2026
2 checks passed
@Scottcjn
Copy link
Owner

Scottcjn commented Mar 5, 2026

Merged + paid 2 RTC to zhangxue1985122219 (pending 573). Windows troubleshooting guide is a nice addition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants