Skip to content

Commit 400b39f

Browse files
committed
docs: clean up and simplify documentation
- Remove unnecessary documentation files - Simplify README and docs - Update project structure
1 parent 75b6389 commit 400b39f

25 files changed

+1672
-2637
lines changed

AUDIT_REPORT_2025_FINAL.md

Lines changed: 0 additions & 411 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,22 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
4-
53
## [Unreleased]
64

75
### Added
8-
- Comprehensive button and keyboard verification
9-
- Thread-safe counter updates for bulk operations
10-
- FloodWaitError and SessionRevokedError handling
11-
- Automatic revoked session cleanup
12-
- Improved error handling and validation
13-
- Complete test coverage for all handlers
14-
15-
### Fixed
16-
- Race conditions in concurrent operations
17-
- Memory leaks in handlers dictionary
18-
- Duplicate error messages
19-
- Missing handlers for poll bulk operations
20-
- Thread safety issues in conversation state management
6+
- Professional keyboard navigation with back buttons
7+
- Improved UI organization and layout
8+
- Enhanced error handling and cleanup
219

2210
### Improved
23-
- Error messages consistency
2411
- Code organization and structure
25-
- Documentation and README
26-
- Test coverage and quality
12+
- Documentation
13+
- User interface consistency
2714

2815
## [1.0.0] - 2025-01-27
2916

3017
### Initial Release
3118
- Account management system
3219
- Message monitoring with keywords
33-
- Bulk operations (reaction, poll, join, block, send PV, comment)
34-
- Individual operations
20+
- Bulk and individual operations
3521
- Statistics and reporting
3622
- Complete test suite
37-

CONTRIBUTING.md

Lines changed: 13 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,24 @@
1-
# Contributing to Telegram Panel
2-
3-
Thank you for your interest in contributing to Telegram Panel! This document provides guidelines and instructions for contributing.
1+
# Contributing
42

53
## Getting Started
64

75
1. Fork the repository
8-
2. Clone your fork: `git clone https://github.com/your-username/Telegram-Panel.git`
9-
3. Create a branch: `git checkout -b feature/your-feature-name`
10-
4. Make your changes
11-
5. Test your changes
12-
6. Commit: `git commit -m "Add your feature"`
13-
7. Push: `git push origin feature/your-feature-name`
14-
8. Open a Pull Request
6+
2. Create a feature branch: `git checkout -b feature/your-feature`
7+
3. Make your changes
8+
4. Test: `pytest tests/`
9+
5. Commit: `git commit -m "Add feature"`
10+
6. Push: `git push origin feature/your-feature`
11+
7. Open a Pull Request
1512

1613
## Code Style
1714

18-
- Follow PEP 8 style guide
19-
- Use meaningful variable and function names
20-
- Add docstrings to functions and classes
21-
- Keep functions focused and small
22-
- Use type hints where helpful
23-
24-
## Testing
25-
15+
- Follow PEP 8
16+
- Use meaningful names
17+
- Add docstrings
2618
- Write tests for new features
27-
- Ensure all existing tests pass
28-
- Run tests before submitting: `pytest tests/`
29-
- Aim for high test coverage
3019

3120
## Commit Messages
3221

33-
- Use clear, descriptive commit messages
34-
- Start with a verb (Add, Fix, Update, Remove, etc.)
35-
- Keep the first line under 50 characters
36-
- Add more details in the body if needed
37-
38-
## Pull Request Process
39-
40-
1. Update README.md if needed
41-
2. Add tests for new functionality
42-
3. Ensure all tests pass
43-
4. Update documentation
44-
5. Request review from maintainers
45-
46-
## Reporting Issues
47-
48-
When reporting issues, please include:
49-
- Description of the problem
50-
- Steps to reproduce
51-
- Expected behavior
52-
- Actual behavior
53-
- Environment details (OS, Python version, etc.)
54-
- Relevant logs
55-
56-
## Questions?
57-
58-
Feel free to open an issue for questions or discussions.
59-
22+
- Clear and descriptive
23+
- Start with a verb (Add, Fix, Update, etc.)
24+
- Keep first line under 50 characters

INCOMPLETE_FEATURES.md

Lines changed: 0 additions & 224 deletions
This file was deleted.

0 commit comments

Comments
 (0)