| [Suggestion] Docs folders cleanup[message #325001]
|
Wed, 11 September 2013 01:48 
|
|
 Faalagorn |
 |
Messages:152
Registered:February 2012
Location: Poland |
|
|
While browsing the SVN I realized that there's kind of mess with the docs attached to the project, and they could use some cleanup. I'm taking about all the manuals, readmies, changelogs, spreadsheets, guides etc. that are scattered in the SVN.
Currently there's at least 3 locations where docs are hold:
Moreover, the JA2_DG_Merc.txt file is kept in https://ja2svn.dyndns.org/source/ja2_v1.13_data/GameDir/Data-1.13 for some reason
It's a bit confusing, and since I'm only downloading the source coude itself and game data files, I completely miss the first two folder locations - and I'm sure there's people who aren't even away of their existence.
For starters, how about doing some cleanup and merge the folders? Or at least move some files accordingly? First I thought that the docs in the source SVN are all related to the code, but it's not exactly the case. Also, there are two locations for docs in source SVN.
Another issue is the age and usefulness of files. Some are outdated and some are simply not needed. Current "Docs" folder size is 62.6 MB and it's included each time someone downloads the folder from SVN. They also make SCIs bigger and installation size is bigger too. On the other hand there are some useful information that are not included in the gamedata SVN that a players and modders could possibly use - and possibly even more on the internet (which could be attached as well, preferrably as an URL).
Some examples:
- While it's nice that there's two manuals attached in the SVN, are they really needed? Everyone have it's own manual in the game files anyway after installing JA2.
- Same applies to JA2_Patch112.txt
- Original JA1 Deadly Games Faces.png file in /Developer_Docs is not really needed, especially after all JA1/DG mercs were added
- JA2_DG_Merc.txt is sitting in the wrong folder
If there's a need for it, I cna list more changes, or spend some time trying to categorize the files, but first I'd like to know how the files should be split - what goes where and know your opinions about this 
Report message to a moderator
|
Staff Sergeant
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Blog
Search
Help
Members
Register
Login
Home
