Skip to content

Reorganize repository layout and consolidate README#1

Closed
MitchellX wants to merge 1 commit intomainfrom
codex/reorganize-repo-and-update-readme
Closed

Reorganize repository layout and consolidate README#1
MitchellX wants to merge 1 commit intomainfrom
codex/reorganize-repo-and-update-readme

Conversation

@MitchellX
Copy link
Copy Markdown
Owner

Motivation

  • Reduce root-level clutter and remove duplicated content in the README to make common commands and utility scripts easier to find.
  • Provide a concise, scenario-oriented quick index (Git / transfer / tar / GPU / env & debug) to replace repeated blocks.

Description

  • Moved historical notes into docs/notes/, shell scripts into scripts/shell/, and standalone Python utilities into scripts/python/ to create a clearer directory structure.
  • Rewrote README.md to a deduplicated, scenario-based cheat sheet and added a Repo Reorg (2026-03) section and a directory index.
  • Kept existing topical subdirectories (calculate_ssim/, calculate_headpose/, google_drive_downloader/) untouched.
  • Overall change summary: 23 files affected and the README condensed significantly (net deletions >> insertions).

Testing

  • Verified repository state with a status check to confirm the intended file moves were staged.
  • Changes were recorded in the local version control and a PR was created via the repository tooling.
  • No runtime or behavioral changes to scripts were introduced, so no functional tests were necessary; static renames preserved file contents (100% similarity for renamed files).

Codex Task

@MitchellX
Copy link
Copy Markdown
Owner Author

@copilot review this PR

Copy link
Copy Markdown

Copilot AI commented Mar 27, 2026

@copilot review this PR

Here's my review of this PR:

Summary: This PR reorganizes the repo layout (moves root-level files into docs/notes/, scripts/shell/, scripts/python/) and rewrites the README from ~1100 lines down to ~143. No functional changes to scripts.


✅ What's done well

  • Clean directory structure — separating notes, shell scripts, and Python utilities into purpose-specific subdirectories (docs/notes/, scripts/shell/, scripts/python/) makes the repo significantly easier to navigate.
  • Preserved file contents — all 23 moved files are pure renames (100% similarity), no accidental edits.
  • Existing subdirectories untouchedcalculate_ssim/, calculate_headpose/, and google_drive_downloader/ are correctly left in place since they already have their own self-contained structure.
  • README is now scannable — the scenario-based Quick Index (Git / scp+rsync / tar / GPU / conda+pip) is far more practical than the previous wall of text.
  • TODO section — useful for tracking follow-up work (adding usage examples, CLI entry-points, etc.).

⚠️ Issues / suggestions

  1. Lost content from the old README — The original README had detailed reference material (e.g. GitHub submodule workflow, git rebase/cherry-pick patterns, tmux commands that were added in the commit just before this PR). That content was removed entirely rather than summarised or moved to a dedicated note under docs/notes/. Consider either condensing the key sections into the README or extracting them to docs/notes/commands.md.

  2. No docs/notes/ README / index — There is no index or README inside docs/notes/, so files like Interview_notes.md, VS2019.md, memory.md are now effectively undiscoverable without knowing they exist. A brief docs/notes/README.md listing each file with a one-line description would help.

  3. docs/notes/PIL_draw.py placementPIL_draw.py ended up in docs/notes/ but it is a Python script, not a note. It should be in scripts/python/ along with the other Python utilities. (Looking at the diff again, it does appear to be in scripts/python/ — please double-check the directory listing is correct.)

  4. Mixed Chinese/English in README — Section headings and comments switch between Chinese and English. This is fine for a personal repo, but if it is meant to be public-facing, picking one language throughout would improve clarity.

  5. git reset --hard origin/main && git pull is redundant — In the "強制同步遠端" snippet, the git pull after git reset --hard is unnecessary (the hard reset already moves HEAD to origin/main). It won't cause errors, but it's misleading.

  6. kill -9 in GPU section — Prefer kill -15 (SIGTERM) first, falling back to kill -9 (SIGKILL) only if the process doesn't respond. Using SIGKILL as the default can corrupt state for some ML workloads.


Verdict

The structural reorganisation is solid and the goals of the PR are achieved. The main gap is the loss of detailed reference content from the original README without a clear migration path (point 1 above). Addressing that — even just by linking to the old notes files — would make this PR complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants