Document 7 GitHub issues for codebase cleanup #2
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.
Created comprehensive documentation for systematic cleanup of repository structure, addressing duplicate scripts, unclear content organization, missing files, and outdated references.
Files Added
ISSUES_TO_CREATE.md (1,581 lines) - 7 detailed issues ready to copy to GitHub:
build_book.shscripts (2 conflicting implementations)Content/folder purpose (368KB, unclear relationship to book-src)HOW_TO_CREATE_ISSUES.md - Manual and automated creation methods
CLEANUP_SUMMARY.md - Executive overview with dependencies
README_ISSUES.md - Quick reference with priority matrix
.github/ISSUE_TEMPLATE.md - Reusable template
Issue Structure
Each issue contains:
Total effort estimate: 20-31 hours
Creation Order
Usage
Note: Issues designed to be created sequentially due to dependencies. Each is self-contained with full context.
Original prompt
create the issues one at a time
[Chronological Review: The conversation began with the user requesting a review of a 30-day syllabus and updates to bash files. The user then asked for a detailed updated layout of the project. Following that, the user attempted to run a script (`build_book.sh`) which resulted in multiple errors due to missing files. The user inquired about the usage of a content folder and requested a full review of the codebase to identify unnecessary files. The conversation progressed with the user asking to create detailed issues on GitHub, and finally, the user requested to create issues one at a time.][Intent Mapping:
[Technical Inventory:
build_book.shfor building project documentation.[Code Archaeology:
build_book.sh: Script that failed to copy several files due to missing paths.main_curriculum.md,ab_test_analysis.md, etc., which are crucial for project documentation.][Progress Assessment:
[Context Validation: All user requests and commands are captured, ensuring continuity in the project management and codebase review.]
[Recent Commands Analysis:
chmod +x ./scripts/build_book.shand./scripts/build_book.sh.1. Conversation Overview: - Primary Objectives: - "review the 30 day syllabus and update the bash files accordingly" - "create a detailed updated layout of the project" - "is the content folder used?" - "to a full review of the code base, and flag and identify files no longer needed" - "create the issues on github, providing extrema details" - "create the issues one at a time" - Session Context: The conversation has focused on reviewing and updating project documentation, managing the codebase, and creating detailed issues on GitHub. - User Intent Evolution: The user started with requests for updates and reviews, then moved towards issue creation and project organization.- Technical Foundation:
- Bash Script:
- Markdown Files: Various reports and curriculum files referenced in the script.
- Codebase Status:
- Purpose: Automates the building of project documentation.
- Current State: Failed to execute due to missing files.
- Key Code Segments: Copy commands that reference several important Markdown files.
- Dependencies: Relies on the existence of specific curriculum and report files.
- Problem Resolution:
- Issues Encountered: Multiple "cannot stat" errors indicating missing files during the execution of the build script.
- Solutions Implemented: None yet; the user is in the process of identifying and resolving these issues.
- Debugging Context: The user is assessing the relevance of folders and files in the project.
- Lessons Learned: The importance of verifying file paths before executing scripts.
- Progress Tracking:
- Completed Tasks: User has attempted to run the build script.
- Partially Complete Work: Review of the syllabus and bash files, and the creation of GitHub issues is pending.
- Active Work State:
- Current Focus: The user was working on executing the build script and addressing the resulting errors.
- Recent Context: The user has been troubleshooting the build process and assessing the project structure.
- Working Code: The
- Immediate Context: The user was trying to build documentation when the token budget was exceeded.
- Recent Operations:
build_book.sh- Used for building project documentation.build_book.sh:build_book.shscript was the focus of recent discussions....
Created from VS Code via the GitHub Pull Request extension.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.