Skip to content

docs: add projects/index migration investigation and plan#165

Open
JeffySam wants to merge 22 commits intothoth-tech:mainfrom
JeffySam:main
Open

docs: add projects/index migration investigation and plan#165
JeffySam wants to merge 22 commits intothoth-tech:mainfrom
JeffySam:main

Conversation

@JeffySam
Copy link

Description

This PR adds documentation for the migration of the
projects/index parent state from AngularJS to Angular.

Included documents

  • Projects Index Migration Investigation

    • Describes current migration status
    • Confirms Angular implementation completeness
    • Identifies legacy AngularJS files pending removal
    • Lists dependent child states and verification requirements
  • Projects Index Migration Plan

    • Defines verification steps before cleanup
    • Outlines safe removal of legacy files
    • Provides testing checklist and success criteria

Scope

  • Documentation only
  • No production code changes

Purpose

To provide clear technical context and a structured, low-risk path
to finalising the projects/index parent state migration.

@netlify
Copy link

netlify bot commented Jan 30, 2026

Deploy Preview for thoth-tech ready!

Name Link
🔨 Latest commit e66b39a
🔍 Latest deploy log https://app.netlify.com/projects/thoth-tech/deploys/697f58edd39a0800081428f7
😎 Deploy Preview https://deploy-preview-165--thoth-tech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Collaborator

@SteveDala SteveDala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @JeffySam,

I checked out your changes locally. The content of the two documents seems a little trivial, but I think there's probably a place for this kind of process or action log. I don't think that place is in the root Markdown directory of src/content/docs; currently the only way to view your contribution is to directly navigate to /projects_index_migration_plan/, try this link to see what I'm talking about - or similar for your investigation document.

  1. Please try to find a new location for these two files, perhaps under src/content/docs/Products/OnTrack/Documentation/Front End Migration/Migration.

In addition, the table on the rendered page looks kind of bad:

Image

Notice the right-hand column extending all the way to the right of the container. This isn't your fault, but I think it should be fixed:

  1. You can find the custom CSS at src/content/styles/custom.css. Please add the following property and value inside the CSS rule for .sl-markdown-content table selector: max-width: max-content;

@JeffySam
Copy link
Author

hi @SteveDala Thanks for the review!

  • Moved both documents under:
    src/content/docs/Products/OnTrack/Documentation/Front End Migration/Migration/
    so they’re no longer in the root docs directory.

  • Added max-width: max-content; to the
    .sl-markdown-content table rule in
    src/styles/custom.css to address the table layout issue you noted.

Copy link
Collaborator

@SteveDala SteveDala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still a couple of nits. See below

verify that subscriptions are cleaned up correctly, and confirm that behaviour
matches the legacy implementation.

## Child State Verification Matrix
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table that was previously here no longer exists. Was this intentional? If so, please remove this heading.

@JeffySam
Copy link
Author

@SteveDala Thanks for the follow-up!

  • Removed the leftover “Child State Verification Matrix” heading since the table was intentionally replaced.

  • Updated the verification checklist to use [x] to clearly indicate these checks were completed as part of the migration validation process.

Copy link
Collaborator

@SteveDala SteveDala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. @BrianDangDev please proceed with an approving review to merge.

@JeffySam
Copy link
Author

Hi @SteveDala , quick heads-up — I removed the Units module docs from this PR as they’re meant for a separate documentation PR. The originally approved content is unchanged.

Could you please re-approve when you get a moment? Thanks!

@SteveDala
Copy link
Collaborator

As the content is not substantially different than my previous approval, the approval stands.

@BrianDangDev
Copy link
Contributor

Hi @JeffySam , a check failed, please have a look at the highlighted text and follow the instruction to fix the format issue, should be a simple fix
image

@JeffySam
Copy link
Author

@BrianDangDev hey brian i have fixed the issue, hopefully it'll pass all the tests now

@BrianDangDev
Copy link
Contributor

Prettier error still show up @JeffySam

@BrianDangDev
Copy link
Contributor

@JeffySam please sync your branch with main then i will run the checks again

@SteveDala
Copy link
Collaborator

SteveDala commented Feb 1, 2026

Hi @JeffySam, in your local development environment, please execute npm run format.

Checking formatting...
[warn] src/content/docs/Products/OnTrack/Documentation/Front End Migration/Migration/PROJECTS_INDEX_MIGRATION_INVESTIGATION.md
[warn] src/content/docs/Products/OnTrack/Documentation/Front End Migration/Migration/PROJECTS_INDEX_MIGRATION_PLAN.md
[warn] Code style issues found in 2 files. Run Prettier with --write to fix.
Error: Process completed with exit code 1.

@SteveDala
Copy link
Collaborator

@JeffySam please make sure your changes are based on the latest upstream changes to main.

@JeffySam
Copy link
Author

JeffySam commented Feb 1, 2026

@SteveDala i did everything and its still failing the tests

@SteveDala
Copy link
Collaborator

SteveDala commented Feb 2, 2026

@JeffySam, I have recently forked the main branch of this repository, opened it in the VSCode development container, and ran all the checks that the GitHub CI pipeline runs. All came back successful, including Prettier. In addition, your attempts to fix the linting issues means your pull request is now extremely big compared to the actual scope of the change requested.

I believe you should try again with a fresh fork of the main branch. In your terminal, run this (make a new copy of the repo):

git clone https://github.com/thoth-tech/ThothTech-Documentation-Website.git
cd ThothTech-Documentation-Website
git remote rename origin upstream
git remote add origin https://github.com/JeffySam/ThothTech-Documentation-Website.git

Place the Markdown files for the original pull request in the folder locally (while on the main branch), then run...

git add .
git commit -m "docs: add projects/index migration investigation and plan"
git push origin --force

This should tidy up your pull request and provided the Markdown files are formatted and pass the Vale checks, we should be good to merge them.

@JeffySam
Copy link
Author

JeffySam commented Feb 2, 2026

Hey @SteveDala I did all this already and even in my terminal it’ says the same..
Image 02-02-26 at 3 15 PM
But in git it still not passing the tests

@SteveDala
Copy link
Collaborator

@JeffySam Again, I suggest you clone a new copy of the repo and follow the steps I outlined above. I'm not sure how your original repo ended up the way it is now and there's only so much I can do to support your errors from GitHub.

One clue that might be worth checking is that I noticed in the image above you are currently on the branch docs/units-module-migration-clean which is not the right branch for this pull request (it should be main).

image

@JeffySam
Copy link
Author

JeffySam commented Feb 2, 2026

@SteveDala I was on the docs/units-module-migration-clean branch when taking that screenshot. For these two pull requests, I worked on separate documentation branches rather than directly on main, which is why that branch was showing.

I’ll go ahead and clone a fresh copy of the repository and follow the steps you outlined from scratch to rule out any local issues on my end. I’ll update you once I’ve re-tested everything on a clean setup.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants