chore(docs): add documentation links and improve code formatting#4
Merged
raychrisgdp merged 6 commits intomainfrom Jan 2, 2026
Merged
chore(docs): add documentation links and improve code formatting#4raychrisgdp merged 6 commits intomainfrom
raychrisgdp merged 6 commits intomainfrom
Conversation
- Added a new pre-commit hook to prevent commits to the main branch. - Updated the README to clarify current capabilities and usage instructions. - Improved the structure of the documentation by adding "Docs Links" sections in various PR specifications for better navigation. These changes aim to improve project organization, enhance user guidance, and enforce commit policies.
- Added a note in `.pre-commit-config.yaml` to clarify the assumption of the default branch name. - Increased the line length limit in `pyproject.toml` from 100 to 120 for better code readability. - Refactored multiple lines in various Python files to adhere to the new line length and improve overall formatting. These changes aim to enhance code quality and maintainability across the project.
- Modified the `Makefile` to clarify the `make precommit` command, which now includes running a documentation check alongside pre-commit hooks. - Introduced new command files: `review-implement.md` and `review-validate.md`, detailing processes for implementing review findings and validating specs, respectively. - Updated existing documentation in `AGENT_GUIDE.md` and `TESTING_GUIDE.md` to reflect changes in the precommit process and ensure comprehensive testing guidelines. These changes aim to enhance the development workflow and improve documentation clarity for review processes.
- Renamed the review command files to include a personal-todo identifier for better context. - Streamlined the execution steps in `review-implement.md` and `review-validate.md`, enhancing clarity on the processes for implementing findings and validating specs. - Improved the output format in `review.md` to ensure consistency and better readability of findings and validation results. These updates aim to enhance the usability of review commands and improve documentation clarity for developers.
- Revised the structure of `PR_DESCRIPTION.md` to include the title as a markdown heading (`# Title`) followed by a summary section (`## Summary`). - Clarified the process for extracting the title and description when updating GitHub PRs. - Added a new section in `review-implement.md` detailing the format for parsing findings, including extraction of key components such as ID, severity, and change recommendations. These updates aim to improve the clarity and usability of PR descriptions and enhance the documentation for implementing review findings.
- Increased the line length limit from 100 to 120 characters in `AGENTS.md` and `AGENT_GUIDE.md` for better readability. - Added exclusions for `PR_DESCRIPTION.md` in `review-implement.md`, `review-validate.md`, and `review.md` to clarify that this file should not be reviewed or flagged for issues. These updates aim to enhance documentation clarity and improve the review process by clearly defining the scope of review files.
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.
Summary
Issues & Goals:
Implementation Highlights:
docs/02-implementation/pr-specs/with references to relevant design documents, user guides, and implementation guidesbackend/cli/,backend/config.py,backend/database.py,backend/models/) to enforce consistent line length and formatting standardsno-commit-to-branchhook to prevent accidental commits to main branch and updated Makefile to includedocs-checkin precommit workflow.cursor/commands/review-implement.mdand.cursor/commands/review-validate.mdfor automated review workflow support.cursor/commands/review.mdto reflect project-specific patterns (Python 3.11+, ruff formatting, TaskGenie conventions) and simplified structureHow to Test
Documentation Review & Validation:
Since this PR contains primarily documentation and code formatting changes, reviewers should focus on:
Documentation Links Validation:
docs/02-implementation/pr-specs/PR-*.md)PR-001-db-config.md,PR-005-rag-semantic-search.md) to verify "Docs Links" sections are completeCode Formatting Verification:
make formatto ensure all files are properly formattedbackend/cli/db.py,backend/config.py,backend/models/task.py) to ensure formatting is consistent and readablePre-commit Configuration:
make hooksthen attempt a commit to verifyno-commit-to-branchhook worksmake precommitincludes docs-check:make precommitshould run both docs validation and pre-commit checksmainbranch is blocked by the hookREADME Structure:
Cursor Commands:
.cursor/commands/review-implement.md,.cursor/commands/review-validate.md).cursor/commands/review.mdto ensure project-specific patterns are correctly reflected and structure is simplifiedTest Execution:
make testto ensure formatting changes don't break existing testsExpected Behavior:
make precommitshould run both docs-check and pre-commit validationRelated Issues
Author Checklist
mainbranchAdditional Notes
Key Implementation Areas for Review
Documentation Improvements:
docs/02-implementation/pr-specs/*.md: Added "Docs Links" sections to all 17 PR specification files - verify links are accurate and completedocs/INDEX.md: Updated documentation index - verify cross-references are correctREADME.md: Restructured with improved navigation - verify structure is helpful for new usersCode Formatting:
backend/cli/db.py,backend/cli/main.py: Applied ruff formatter - verify formatting is consistent and readable (function signatures reformatted to fit 120-char limit)backend/config.py,backend/database.py: Formatting changes - verify no functional changesbackend/models/*.py: Model formatting updates - verify relationships and field definitions are preservedPre-commit & Tooling:
.pre-commit-config.yaml: Addedno-commit-to-branchhook - verify hook prevents commits to mainMakefile: Updatedprecommittarget to includedocs-check- verify workflow integrationpyproject.toml: Minor updates - verify configuration is correctNew Cursor Commands:
.cursor/commands/review-implement.md: New command for implementing review findings - verify structure and integration.cursor/commands/review-validate.md: New command for validating reviews - verify workflow integration.cursor/commands/review.md: Updated to reflect project-specific patterns - verify Python 3.11+ and TaskGenie conventions are correctly documented, structure simplifiedTest Updates:
tests/cli/test_db.py,tests/cli/test_main.py: Formatting updates - verify tests still passtests/models/*.py: Test formatting changes - verify test logic unchangedtests/test_config.py,tests/test_database.py: Formatting updates - verify functionality preservedtests/test_migrations_env.py: Formatting updates - verify migration testing still worksTesting Notes
.cursor/commands/pr-desc.md,.cursor/commands/review-implement.md) and untracked files (PR_DESCRIPTION.md, review files) but don't affect this PR