Skip to content

Conversation

@PPeitsch
Copy link
Owner

Description

This pull request provides a comprehensive update to the README.md file to ensure it accurately reflects the project's current features, structure, and usage. The previous documentation was outdated and did not cover major new functionalities.

Key changes include:

  • Features: The feature list has been expanded to include the "Interactive Calendar Log" and "Customizable Absence Codes".
  • Screenshot: The placeholder image text has been updated to reflect the new main calendar view.
  • Project Structure: The ASCII diagram has been corrected to show the services directory and the run.py entry point, removing the outdated app.py reference.
  • Quick Start: Added a note to clarify that the init_db.py script is interactive.
  • Usage: The "Usage" section has been rewritten to provide a better overview of the main application features, including the Calendar Log, Summary, and Settings pages.

Type of Change

  • Bug fix
  • New feature
  • Refactoring
  • Documentation update
  • UI/UX improvement
  • Code style update
  • Test coverage
  • Configuration change

Testing

The updated README.md was manually reviewed against the current codebase to verify the accuracy of all information.

  • All instructions in the "Quick Start" section were confirmed to be correct.
  • The project structure diagram was validated against the actual file tree.
  • The feature and usage descriptions were checked to ensure they align with the application's current functionality.
  • Verified that all Markdown renders correctly on GitHub.

Screenshots

N/A - This is a documentation-only update.

Checklist

  • I have followed the project's code style (Black, isort, PEP 8)
  • My code generates no new warnings
  • I have added tests for new functionality
  • All tests pass locally
  • I have updated the documentation where necessary
  • I have run pre-commit hooks before submitting

Fixes #28

@PPeitsch PPeitsch merged commit 6c4b5d0 into main Nov 18, 2025
1 check passed
@PPeitsch PPeitsch deleted the docs/update-readme branch November 18, 2025 04:12
@codecov
Copy link

codecov bot commented Nov 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

⚡ [Docs]: Update README.md to reflect new features and structure

2 participants