achrisdale commented 9 months ago

Audrius, I have imported my 'TNBaseHelp' .rtf document into a HelpNDoc file. It is just a straight import at present and will need some further work. I have been trying to follow your guidance to upload it to GitHub TNBase/Docs, or maybe merge it with the existing 'Help Documentation.hnd' file. Git Hub isn't letting me do either of those things. I am logged in to GitHub as far as I can see. I tried to attach my 'TNBaseHelp.hnd' file here but GitHub won't let me do that either so I'll e-mail it to you. Not sure what I'm doing wrong. Chris

audrius-a commented 9 months ago

Hi Chris, I'm afraid the GitHub would not be able to merge your .hnd file with the existing one. It would simply override the existing one completely. Therefore it is crucial to follow these steps:

Clone the TNBase repository, or pull the latest changes;
Create a new branch based on the latest master branch;
Open the existing Docs/Help Documentation.hnd file in the HelpNDoc application;
Amend the file as required and save it;
Generate chm documentation using HelpNDoc;
Copy the newly generated chm file to src/TNBase/Resource/TNBase.chm overriding the existing file;
Commit the changes to your branch (not master);
Create a Pull Request in GitHub;

I can help you with any or all of the above. Then, once the Pull Request is created, I will review it and merge it to the master branch.

By the way, it would be great if your imported documentation would be broken down into appropriate table of contents sections. At the moment it's just a single page with everything in it. Again, I probably could help you with that.

achrisdale commented 9 months ago

OK. Thanks Audrius. I have look at that tomorrow. I'll let you know if I need help. They seem to make what should be a simple procedure, quite difficult! Yes, I noticed that the .hnd file needs to broken up into sections, which I expect can then be accessed from a menu. I thought that could come later as long as I can edit the help document once it has been added into TNBase. As it is at present, it might be of useful to those in Birminham when they start to use TNBase.

achrisdale commented 9 months ago

Hi, I'm not sure what I need to do: I assume 'Clone' means make a copy of the whole repository. If so, not sure how to do that. Don't know what 'Pull' means although I can see the 'Pull requests' menu item and then 'new Pull requests' then 'Create pull request'. Not sure what to do with that.

audrius-a commented 9 months ago

GitHub is rather complicated for documentation changes that you want to do. Unfortunately, I do not have a better option as GitHub is essential for application development and maintaining the history of it. I do not expect you to learn all this and that is why I suggested that I could help with updating the documentation.

On the other hand, it might be useful to understand the terminology of GitHub and the basic use of it. I found this video that seems to explain it simply and clearly: https://www.youtube.com/watch?v=8Dd7KRpKeaE It doesn't mention cloning but that is what you would do with the existing repository (as opposed to creating a new repository as in the video) to copy it to your local machine. It's just a menu option in GitHub Desktop under File -> Clone repository... "Pull" is the opposite action of "Push" that is described in the video, which basically means - get the latest version of the code to your local machine.

There are other videos and materials for how to use GitHub and GitHub Desktop so just search around in Youtube or Google. We could also setup a remote session where I can show you how it works.

One thing I would ask you is to never commit or push changes directly to the "master" branch as that one should always be a working "clean" version of the code. Just create a new branch of the master as shown in the video and push your changes. Let me know the branch name when ready and I can sort out the Pull Request for you.

achrisdale commented 9 months ago

Thanks Audrius. I'll have a look at the video before asking for further help. OK, warning noted!

Also thanks for your other message. I'm sure Tom will be pleased to hear from you even if you just explain that you have been too busy.

Regards,

Chris

In message @.> Audrius @.> wrote:

GitHub is rather complicated for documentation changes that you want to do. Unfortunately, I do not have a better option as GitHub is essential for application development and maintaining the history of it. I do not expect you to learn all this and that is why I suggested that I could help with updating the documentation.

On the other hand, it might be useful to understand the terminology of GitHub and the basic use of it. I found this video that seems to explain it simply and clearly: https://www.youtube.com/watch?v=8Dd7KRpKeaE It doesn't mention cloning but that is what you would do with the existing repository (as opposed to creating a new repository as in the video) to copy it to your local machine. It's just a menu option in GitHub Desktop under File -> Clone repository... "Pull" is the opposite action of "Push" that is described in the video, which basically means - get the latest version of the code to your local machine.

There are other videos and materials for how to use GitHub and GitHub Desktop so just search around in Youtube or Google. We could also setup a remote session where I can show you how it works.

One thing I would ask you is to never commit or push changes directly to the "master" branch as that one should always be a working "clean" version of the code. Just create a new branch of the master as shown in the video and push your changes. Let me know the branch name when ready and I can sort out the Pull Request for you.