Skip to content

docs: add BLE firmware version compatibility note#6

Merged
curlysasha merged 1 commit intomasterfrom
claude/issue-4-20260106-0927
Jan 6, 2026
Merged

docs: add BLE firmware version compatibility note#6
curlysasha merged 1 commit intomasterfrom
claude/issue-4-20260106-0927

Conversation

@curlysasha
Copy link
Owner

Add warning about BLE scanning issues with firmware v2.7.15+ to both English and Russian README files. Recommend downgrading to v2.7.14 for reliable BLE functionality.

Resolves #4

Generated with Claude Code

Add warning about BLE scanning issues with firmware v2.7.15+ to both English and Russian README files. Recommend downgrading to v2.7.14 for reliable BLE functionality.

Resolves #4

Co-authored-by: curlysasha <curlysasha@users.noreply.github.com>
@claude
Copy link

claude bot commented Jan 6, 2026

Pull Request Review

Summary

This PR adds important documentation about BLE firmware compatibility issues to both English and Russian README files. The changes properly address issue #4 by warning users about known BLE scanning problems with firmware v2.7.15+.


✅ Strengths

  1. Addresses Real Issue: The documentation directly addresses a real user problem identified in issue Scan BLE Devices ничего не находит #4 with clear, actionable guidance
  2. Bilingual Support: Changes are consistently applied to both README.md and README.ru.md, maintaining documentation parity
  3. Good Placement: The note is positioned immediately after the BLE connection example where users need it most
  4. Clear Messaging: Uses blockquote format (>) making the warning visually distinct and noticeable
  5. Actionable Guidance: Provides specific version numbers (v2.7.14 working, v2.7.15+ problematic) and recommends a clear solution

📝 Suggestions for Improvement

1. Add Link to Issue or Documentation (Minor)

Consider linking to issue #4 or relevant Meshtastic documentation for users who want more context:

> **Note**: BLE scanning may not work with all firmware versions. Known working versions: up to v2.7.14. If you experience issues with BLE scanning on firmware v2.7.15 or newer, consider downgrading to v2.7.14. See [issue #4](https://github.com/curlysasha/MeshRadar/issues/4) for details.

2. Consider Phrasing (Minor)

The phrase "Known working versions: up to v2.7.14" could be slightly clearer:

Current:

Known working versions: up to v2.7.14.

Alternative (more explicit):

Known working version: v2.7.14 and earlier.

Or in Russian:

Проверенная рабочая версия: v2.7.14 и ранее.

This makes it crystal clear that 2.7.14 works and everything before it should work too.

3. Consistency Check (Nitpick)

Russian version says "до v2.7.14 включительно" (up to and including v2.7.14) which is slightly more explicit than the English "up to v2.7.14". Both are correct, but you might want to match the explicitness:

English: "up to and including v2.7.14"


🔒 Security Considerations

No security concerns - Documentation-only changes


🐛 Potential Issues

No bugs identified - Simple, safe documentation additions


⚡ Performance Considerations

Not applicable - Documentation changes don't affect performance


🧪 Test Coverage

Not applicable - No code changes requiring tests


📐 Code Quality & Best Practices

  • ✅ Consistent formatting with existing README structure
  • ✅ Proper Markdown syntax
  • ✅ Maintains bilingual documentation standards
  • ✅ Follows conventional commit format in title: docs: add BLE firmware version compatibility note
  • ✅ Good PR description with clear summary and issue reference

🎯 Final Recommendation

APPROVE

This is a solid documentation improvement that addresses a real user pain point. The changes are minimal, safe, and provide valuable information to users experiencing BLE scanning issues.

The suggestions above are minor enhancements - the PR is ready to merge as-is if you prefer. The current implementation effectively solves the problem and maintains documentation quality.

Great work addressing user feedback quickly! 🚀


File-by-File Review

README.md:177

  • ✅ Clear warning message
  • ✅ Proper blockquote formatting
  • ✅ Logical placement after connection example

README.ru.md:177

  • ✅ Accurate Russian translation
  • ✅ Consistent formatting with English version
  • ✅ Natural Russian phrasing

@curlysasha curlysasha merged commit 2b2c8eb into master Jan 6, 2026
1 check passed
@curlysasha curlysasha deleted the claude/issue-4-20260106-0927 branch January 6, 2026 14:49
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

Successfully merging this pull request may close these issues.

Scan BLE Devices ничего не находит

1 participant