wwarthen / RomWBW

System Software for Z80/Z180/Z280 Computers
GNU Affero General Public License v3.0
323 stars 93 forks source link

Doc Folder Minor Reorg (Trivial) #395

Closed kiwisincebirth closed 2 months ago

kiwisincebirth commented 2 months ago

Suggestion for cosmetic improvement

The Doc folder of this project has become a little large, and would benefit from a couple of sub folders. If you like I could create a Pull request for the following 2 new folders

CPM - Clearly anything to do CPM or any of the many derivatives Language - Anything to do with a programming language

Apart from the above I cant suggest any further changes since the remaining files fall into a Misc category, and any organisation would be better suited to a main project contributor. However my only suggestion would be a Hardware folder, since there seem to be alot of small documents (including in Contrib folder) that describe an aspect of hardware.

wwarthen commented 2 months ago

Hi @kiwisincebirth,

Yes, this is a good idea.

The only tricky part is that there are references to the location of these documents scattered about the distribution. To do this correctly, all of the RomWBW source documents (in Source\Doc) and all of the ReadMe.doc files throughout the project will need to be reviewed and adjusted as needed.

If you are OK with doing all of that, feel free to do a Pull Request.

Thanks!

Wayne

fixit9660 commented 2 months ago

I’d be happy to help with that, if you’d like?

Cheers,

Andy.

IMPORTANT NOTICE:

This e-mail (including all attachments) is confidential and may be privileged. It is for the exclusive use of the intended recipient(s) only, and must not be re-transmitted in an amended form without my consent. If you are not the named recipient, please notify me immediately and do not disclose the contents to any other person or make any copies. Please then delete it and do not disclose its contents to any other person.

Security and reliability of e-mails are not guaranteed. I operate anti-virus programs but you must take full responsibility for virus checking this e-mail (including all attachments). I do not accept any liability in respect of any damage caused by any virus which is not detected.

All e-mails to and from anyone @kendallnet.co.uk may be examined for breaches of employee policies and the law. I record all phone calls.

From: Wayne Warthen @.*** Sent: 10 May 2024 16:44 To: wwarthen/RomWBW Cc: Subscribed Subject: Re: [wwarthen/RomWBW] Doc Folder Minor Reorg (Trivial) (Issue #395)

Hi @kiwisincebirth https://github.com/kiwisincebirth ,

Yes, this is a good idea.

The only tricky part is that there are references to the location of these documents scattered about the distribution. To do this correctly, all of the RomWBW source documents (in Source\Doc) and all of the ReadMe.doc files throughout the project will need to be reviewed and adjusted as needed.

If you are OK with doing all of that, feel free to do a Pull Request.

Thanks!

Wayne

— Reply to this email directly, view it on GitHub https://github.com/wwarthen/RomWBW/issues/395#issuecomment-2104830020 , or unsubscribe https://github.com/notifications/unsubscribe-auth/AF4B5XZU4UFYWPZC3CQU5GDZBTTLNAVCNFSM6AAAAABHQG2EDOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBUHAZTAMBSGA . You are receiving this because you are subscribed to this thread. https://github.com/notifications/beacon/AF4B5X5OGI26T265ODYGAMDZBTTLNA5CNFSM6AAAAABHQG2EDOWGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTT5OUUEI.gif Message ID: @.***>

kiwisincebirth commented 2 months ago

all of the RomWBW source documents (in Source\Doc) and all of the ReadMe.doc files throughout the project will need to be reviewed and adjusted as needed.

From what I can see the $doc_root$ is the once that Have to be corrected. Most other I see just refer to the document by name (sometime folder) and just a wording change to refer to the folder.

Also a readme.txt change in the /Doc folder itself, to move content into a new Readme in the new subfolder

kiwisincebirth commented 2 months ago

I have done the main changes. If there other files that need moving let me know. I think I did the main ones. I dont know the history of the Contrb folder but two files could be moved. ZSystem.txt and Microsoft NASCOM Basic.docx

Also I found 2 (mostly identical) The Cowgol Language files - not sure why they are 2 - one has a couple of extra pages.

wwarthen commented 2 months ago

Awesome. Thank you @kiwisincebirth. This is crazy weekend for me, so please give me a little time to do a quick review and merge your changes.

Greatly appreciate the contribution!

Thanks,

Wayne

wwarthen commented 2 months ago

Hi @kiwisincebirth,

Very sorry for the delay. I normally get to these merge requests much faster, but this weekend was a lost cause.

You are correct that there are duplicate Cowgol documents out there. I will remove one of them.

Your changes look great and it appears you have thoroughly updated appropriate references. I am merging your changes now. Note that you will see another check-in from me in a few minutes because I need to do the normal PDF documentation regeneration.

Thank you for you help with this!

Wayne

wwarthen commented 2 months ago

Pull Request #396 has been merged and resolves this issue. Closing the issue.

Thanks,

Wayne