 wes
|
1ce475f7dc
|
Clean up documentation for public release
Changes:
- Rewrote PROTOCOL_FINDINGS.md to be clean protocol spec
- Removed all DLL/assembly/class name references
- Removed outdated "Next Steps" sections
- Focused purely on protocol documentation
- Added clear packet examples and command reference
- Removed outdated historical docs:
- SUMMARY.md (investigation notes, now obsolete)
- ANALYSIS_GUIDE.md (pre-completion guide, no longer needed)
- Created .claude.md for internal context
- Contains all decompilation details
- Lists specific DLL names and source locations
- Preserves context for AI assistants
- Added to .gitignore (not committed to repo)
Result:
- Public repo now has clean, legal documentation
- Internal context preserved for development
- Reduced legal surface area
- Docs focus on protocol, not implementation source
Remaining docs (all clean):
- PROTOCOL_FINDINGS.md - Protocol specification
- IMPLEMENTATION_GUIDE.md - Python implementation guide
- HOME_ASSISTANT_INTEGRATION.md - HA integration plan
- MISSION_ACCOMPLISHED.md - Project summary
|
2025-12-29 09:45:06 -05:00 |
|
|
wes
|
718a13c02f
|
Reorganize repository structure into logical folders
Structure:
- src/ - Python implementation (cobs_protocol.py, onecontrol_client.py)
- docs/ - All documentation markdown files
- scripts/ - Extraction scripts (for reference only)
Changes:
- Moved Python files to src/
- Moved all .md docs to docs/
- Moved extraction scripts to scripts/
- Updated README.md with new structure
- Updated import paths in README examples
- Added placeholder for future Quartz documentation URL
Benefits:
- Cleaner repository organization
- Easier to navigate
- Separates code from documentation
- Follows standard project conventions
|
2025-12-29 09:33:20 -05:00 |
|