mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-23 19:16:14 +00:00
Phase 4 of the docs portion of the rfc-5737-cleanup. Replaces all 192.168.1.x example IPs in tracked .md / .txt files with the equivalent last-octet under 192.0.2.x. 192.168.1.x is RFC-1918 private space and routes on real networks, which leaves readers guessing whether a documented IP is a placeholder or a documented LAN. 192.0.2.0/24 is reserved by RFC 5737 exclusively for documentation — readers know on sight that they're examples. 58 files touched, 551 line pairs. Includes .github issue/PR templates, all docs/ references, example READMEs, and one script doc. No code changes, no test changes; test files still carry the 192.168.1.x placeholder pending Phase 2 in _/RFC-5737-cleanup/assessment.md. Also fixed a small fallout in docs/analysis/ANONYMIZATION-SUMMARY.md where the explanatory sentence "a reader can't tell whether 192.168.1.10 is a placeholder or a documented LAN address" had itself been swept by the regex (inverting the point); restored the literal example and noted the sweep progress inline. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
---
|
|
name: Feature request
|
|
about: Suggest an idea for this project
|
|
title: ''
|
|
labels: 'enhancement'
|
|
assignees: ''
|
|
|
|
---
|
|
|
|
**Is your feature request related to a problem? Please describe.**
|
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
|
|
**Describe the solution you'd like**
|
|
A clear and concise description of what you want to happen.
|
|
|
|
**Describe alternatives you've considered**
|
|
A clear and concise description of any alternative solutions or features you've considered.
|
|
|
|
**Use case**
|
|
Describe your specific use case and how this feature would benefit you and other users.
|
|
|
|
**SoundTouch API Support**
|
|
- [ ] This feature is supported by the official SoundTouch API
|
|
- [ ] This feature is NOT supported by the SoundTouch API (custom enhancement)
|
|
- [ ] I'm not sure if this is supported by the SoundTouch API
|
|
|
|
**API Documentation Reference (if applicable)**
|
|
If this feature is based on a SoundTouch API endpoint, please provide:
|
|
- Endpoint URL: [e.g. GET /newendpoint]
|
|
- Documentation reference: [page number or section in official API docs]
|
|
- XML request/response examples: [if known]
|
|
|
|
**Implementation Details (optional)**
|
|
If you have ideas about how this could be implemented:
|
|
- Suggested package/module: [e.g. pkg/client, cmd/soundtouch-cli]
|
|
- Method signatures: [if you have suggestions]
|
|
- CLI commands: [if this affects the CLI tool]
|
|
|
|
**Device Compatibility**
|
|
- SoundTouch models this applies to: [e.g. all models, SoundTouch 20+, specific models]
|
|
- Have you tested this manually: [e.g. via curl, Postman, etc.]
|
|
|
|
**Examples**
|
|
Provide examples of how you would like to use this feature:
|
|
|
|
```go
|
|
// Go library example
|
|
client.NewFeature(parameters)
|
|
```
|
|
|
|
```bash
|
|
# CLI example
|
|
soundtouch-cli --host 192.0.2.100 new-feature --param value
|
|
```
|
|
|
|
**Priority**
|
|
- [ ] Critical - blocks important functionality
|
|
- [ ] High - would significantly improve user experience
|
|
- [ ] Medium - nice to have enhancement
|
|
- [ ] Low - minor improvement
|
|
|
|
**Additional context**
|
|
Add any other context, screenshots, or examples about the feature request here.
|
|
|
|
**Related Issues**
|
|
- Related to #[issue number]
|
|
- Depends on #[issue number]
|
|
- Blocks #[issue number]
|
|
|
|
---
|
|
|
|
**Checklist**
|
|
- [ ] I have searched existing issues to avoid duplicates
|
|
- [ ] I have checked the documentation to ensure this feature doesn't already exist
|
|
- [ ] I have provided a clear use case and rationale
|
|
- [ ] I have considered the impact on existing functionality
|
|
- [ ] I understand this may require SoundTouch API support to implement |