Detailed Change Log: Change Tracking Workflow

Detailed Change Log: Change Tracking Workflow

Date: 2026-04-21 Repository: YanWin/YanWin.github.io High-level entry: website-change-overview.md

Request

Update the task and logs, then commit the current changes. Add a high-level overview markdown file that lists website changes. Add a logs folder with in-depth logs for individual updates. Make the high-level file point to the detailed logs so future website changes done with AI always leave both a high-level and low-level record. Add instructions markdown and Copilot instructions if helpful for future tasks.

Context Map

Files to Modify

FilePurposePlanned Change
docs/website-change-overview.mdNew high-level change indexSummarize completed change sets and point to detailed logs
docs/logs/Detailed change log folderStore in-depth implementation logs for each change set
docs/change-log-workflow.mdMaintenance guideDefine the required logging workflow and file naming rules
.github/copilot-instructions.mdRepo-local AI guidanceInstruct future Copilot sessions to keep high-level and low-level docs in sync
README.mdRepo entry pointLink the new documentation workflow so it is easy to discover

Risks

  • The new documentation structure should not conflict with existing site content docs such as docs/visual-style.md.
  • Existing detailed logs need to remain accessible after the folder reorganization.
  • Future AI tasks should have explicit instructions so the workflow is applied consistently.

Task Steps

  1. Design a permanent high-level and low-level documentation structure.
  2. Move the existing detailed task logs into the new logs folder.
  3. Add a high-level overview file that links to each detailed log and lists key files.
  4. Add a workflow guide for future updates.
  5. Add repo-local Copilot instructions for future AI work.
  6. Update discovery docs and commit the current change set.

Implementation Plan

  • Use docs/website-change-overview.md as the stable top-level index.
  • Use docs/logs/ for all detailed logs, one file per user-facing change set.
  • Preserve the two existing detailed logs by relocating their contents into the new folder.
  • Add a workflow guide with naming rules, expectations, and a reusable template.
  • Add .github/copilot-instructions.md so future AI tasks automatically maintain the logging structure.
  • Update README.md so the new documentation system is easy to find without searching the repository.

Progress Updates

  • Existing task logs and the current repo layout were mapped.
  • The new documentation structure was defined as docs/website-change-overview.md plus docs/logs/.
  • Existing detailed logs were converted into the new folder structure.
  • A workflow guide and repo-local Copilot instructions were added for future tasks.

Final Implementation Results

  • Added a permanent high-level overview in docs/website-change-overview.md.
  • Added a dedicated docs/logs/ folder for detailed implementation logs.
  • Added detailed logs for the CV refresh, the scrollable homepage, and this documentation workflow change.
  • Added docs/change-log-workflow.md as the manual process guide.
  • Added .github/copilot-instructions.md so future AI tasks are expected to update both levels of documentation.
  • Updated README.md so the change-tracking docs are visible from the repo entry point.

Verification Notes

  • Documentation files were checked for structure and internal link consistency.
  • The new overview file points to all detailed logs using relative links within docs/.
  • Existing website implementation changes remain staged in the working tree alongside the new documentation changes, ready for a single commit.

Closure

  • The repository now has a repeatable documentation workflow for future website changes.
  • Future AI-assisted changes can be tracked at both a summary and implementation-detail level without relying on chat history.