Open
Conversation
123c638 to
5fc8821
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request focuses on improving and expanding the project documentation for Shiftings. It introduces comprehensive guides for new and existing features, enhances clarity and consistency across documents, and adds important notes and examples. Additionally, it flags unused utility code for future cleanup. The main changes are grouped below:
Documentation Enhancements and Additions:
Developmentguide (docs/development.md) covering setup, configuration, database initialization, and deployment/upgrade instructions.Eventsdocumentation page (docs/events/index.md) describing the concept, purpose, attributes, permissions, and example use cases for events in the system.Shiftsdocumentation (docs/shifts.md), providing more detailed explanations of shift attributes, creation methods, and participant management.Consistency and Clarity Improvements:
Codebase Maintenance (TODO/FIXME):
FIXMEcomments to flag two unused utility classes/functions (debuginsrc/shiftings/utils/context_processors.pyandAlphaNumericConverterinsrc/shiftings/utils/converters.py), suggesting removal if not needed.