Add Action Plan Document Highlighting Discrepancies and Solutions

[aditya993388]

This PR introduces a detailed action plan document that:

• Identifies discrepancies in the existing documentation.
• Lays out a clear plan of action for addressing these discrepancies.
• Explains the reasons for these changes and the importance of implementing them.

This document aims to ensure consistency, accuracy, and clarity in the documentation process.

[breezy-codes]

I've just gone over the action plan for the documentation and here is my review -

Index.md files

There does seem to be a bit of an excessive use of these in the ontrack side of things, however they are a common occurrence as they typically serve as an entry point to a section, so you would need to strike a balance between where this is needed and where its more so an un-necessary addition.

Repository Structure

I think it would be good to discuss whether 3 repositories is a good idea, having them under the one repo thats the website one - https://thoth-tech.netlify.app/ allows for the ability to share the company site that ideally would be the centralised location for all information.

I've worked on improving quite a few sections within splashkit to be able to say "here this section has everything you need to do xyz" which does make it a lot easier. However, I did notice that ontrack doesn't have these resources earlier this semester when I was assisting in that side in regards to getting set up.

This might be something good to bring up in the leadership meetings, whether we want a repo for each company or a unified one. (having said that, either way ontrack does need to clean up their documentation pages)

Renaming files

I like the idea of having a structured approach to file naming, we try do a similar approach in splashkit. One suggestion you could specify to have all files named using snakecase which is a more identifiable set structure that everyone should know. Setting a standard that this is the naming structure would be a good approach to this issue of the file names.

Name of repos

I think one beneficial thing to do in ontrack would be a README update process. I did this beginning of this semester for every splashkit repo and found some hadn't been updated in 4/5 years. This could be something to be added to the action plan, as well as the repo descriptions. I do also agree the repository naming is also confusing as "what is doubtfire?"

The "Documentation" Repo

If I remember correctly from a prior leadership meeting, there has been a discussion on potentially removing this or going through and sorting it out. This could tie into whether we want a documentation repo per project. Does the project need a place for putting sprints/spikes?

Summary

Overall, its a great plan and something thats definitely needed. One thing I would highlight as a key importance though, is that ontrack needs onboarding documentation ASAP. Preferably on the thoth-tech site so that it can actually be directed to people interested or people starting. That was a significant issue at the beginning of the semester. So it might be good to add that into the action plan as well.

[aditya993388]

I have implemented the suggested changes to the action plan, including emphasizing the need for onboarding documentation for OnTrack, refining the use of index.md files, addressing the repository structure and naming, and standardizing file naming conventions. Let me know if there’s anything else you’d like me to refine!

[nodogx]

I have checked your Action Plan, and it looks perfect. You have done a great job identifying all the major and even minor issues with the documentation. It is great to see that the major issues identified like removing duplication and the need for an OnTrack onboarding hub have already been implemented. I do approve this.

[XinHuang1112]

I have reviewed your action plan and I can confirm that you have found all the errors with the documentation repositories. I believe this plan is the correct plan for correcting all the errors. I am approving this.