Skip to content

Commit 69a1898

Browse files
committed
docs: Complete documentation depuration and updates
- Restored comprehensive content for docs/api.md, docs/faq.md, and docs/troubleshooting.md - Fixed all broken documentation links in README.md - Standardized all documentation filenames to lowercase convention - Updated CHANGELOG.md with versions 1.2.4, 1.2.5, and 1.2.6 - Updated devcontainer.json to install development dependencies - Ensured all .md files follow standardized documentation kit structure
1 parent a5bbcb3 commit 69a1898

6 files changed

Lines changed: 1519 additions & 6 deletions

File tree

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
}
3636
},
3737

38-
"postCreateCommand": "pip install -r requirements.txt && pip install -e .",
38+
"postCreateCommand": "pip install -r requirements.txt && pip install -r requirements-dev.txt && pip install -e .",
3939

4040
"remoteUser": "vscode",
4141

CHANGELOG.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,49 @@ All notable changes to the Telegram Multi-Account Message Sender project will be
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.2.6] - 2025-11-26
9+
10+
### Added
11+
- **API Documentation**: Comprehensive API reference documentation in `docs/api.md`
12+
- **FAQ Documentation**: Complete frequently asked questions guide in `docs/faq.md`
13+
- **Troubleshooting Guide**: Detailed troubleshooting documentation in `docs/troubleshooting.md`
14+
15+
### Fixed
16+
- **Documentation Filenames**: Standardized all documentation filenames to lowercase convention
17+
- **Broken Documentation Links**: Fixed all broken references in README.md and other documentation files
18+
- **Empty Documentation Files**: Restored comprehensive content for previously empty documentation files
19+
- **Documentation References**: Updated all internal documentation links to use correct lowercase filenames
20+
21+
### Changed
22+
- **README.md**: Updated documentation section with correct links and improved structure
23+
- **Documentation Structure**: Ensured all .md files follow standardized documentation kit structure
24+
- **Version Consistency**: Updated version to 1.2.6 in pyproject.toml and setup.py
25+
26+
## [1.2.5] - 2025-11-25
27+
28+
### Fixed
29+
- **CI/CD Pipelines**: Fixed workflow YAML syntax errors and action versions
30+
- **Release Workflow**: Fixed version handling for workflow_dispatch triggers
31+
- **PyPI Upload**: Added validation and error handling for PyPI package uploads
32+
- **macOS Build**: Fixed PyInstaller icon path handling for macOS builds
33+
- **Pytest Configuration**: Made pytest more robust with continue-on-error handling
34+
35+
### Changed
36+
- **GitHub Actions**: Updated action versions and improved workflow reliability
37+
- **Build Process**: Enhanced cross-platform build process with better error handling
38+
39+
## [1.2.4] - 2025-11-24
40+
41+
### Fixed
42+
- **Project Depuration**: Removed unnecessary files, build artifacts, and temporary data
43+
- **Git Configuration**: Fixed dubious ownership issues for repository access
44+
- **Launcher Scripts**: Enhanced run_telegram_sender.bat and created run_telegram_sender.ps1
45+
- **Documentation Standardization**: Renamed and standardized all documentation files
46+
47+
### Changed
48+
- **Project Structure**: Cleaned up project folder structure
49+
- **Documentation**: Standardized documentation file naming conventions
50+
851
## [1.2.3] - 2025-01-23
952

1053
### Added

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,12 @@ Download the appropriate installer from the [Releases](https://github.com/VoxHas
109109

110110
## 📖 Documentation
111111

112-
- **[User Guide](docs/USER_GUIDE.md)**: Comprehensive user guide
113-
- **[API Documentation](docs/API.md)**: Complete API reference
114-
- **[Troubleshooting](docs/TROUBLESHOOTING.md)**: Common issues and solutions
115-
- **[Development Guide](docs/DEVELOPMENT.md)**: Developer documentation
116-
- **[FAQ](docs/FAQ.md)**: Frequently asked questions
112+
- **[Documentation Index](docs/index.md)**: Complete documentation overview
113+
- **[Getting Started](docs/getting-started.md)**: First steps with the application
114+
- **[Usage Guide](docs/usage.md)**: Comprehensive user guide
115+
- **[API Documentation](docs/api.md)**: Complete API reference
116+
- **[Troubleshooting](docs/troubleshooting.md)**: Common issues and solutions
117+
- **[FAQ](docs/faq.md)**: Frequently asked questions
117118
- **[Contributing](CONTRIBUTING.md)**: How to contribute to the project
118119
- **[Roadmap](ROADMAP.md)**: Future development plans
119120

0 commit comments

Comments
 (0)