Posts

Showing posts from October, 2020

Season of Docs: Week 6

We’re half way through the project! 6 weeks has absolutely flown by...  This is what I ticked off the to-do list this week: •  I re-arranged and tidied up the documentation. Each settings tab (or topic, in the case of audio) now has its own dedicated page. All the information you need to understand those settings are in one place; the first section on each page is an overview of the options, the second section goes into more detail, providing some background information and further explanation( or a how-to guide, in the case of the Cloud page). I hope that this way of presenting information is a little less confusing and easier to navigate - any feedback welcomed, as always!  •  I added a section regarding games on the main page; where to get them, where to find which data files you need, and where to find whether they are supported/compatible.   After a discussion with @Mataniko this morning, my timeline for the next couple of weeks is as follows: Week 7: Help:...

Season of Docs: Week 5

  I’ve had a very productive week, now that my personal life has calmed down a bit. I added v2.2.0 information, and finished off the audio and graphics pages. I also created first drafts of the new “saving and loading games” page, as well as contacts, bug reporting, known problems, games notes and copy protection pages.   A catch up with @Mataniko this morning has been very helpful to determine the path forward for the rest of the project, now that the bulk of the information is there. We spoke about what belongs in the documentation, and what doesn’t - and it was decided that things like “Games notes” from the readme, which I experimented with this week, will remain in the wiki, or will be added to the wiki if not there already.  We also spoke about the user experience when navigating the documentation, so for the next week or two I will be tweaking the structure to make sure that the user gets the best possible outcome: Week 6 Re-arranging the docs : •  The...

Season of Docs: Week 4

It’s been a crazy week; sold the boat, moved in with my in-laws, found a rental, moved out of my in-laws’, and moved into the rental.  All in the space of about 4 days! I think it’s time for a nap! Nevertheless, I made a little progress this week, albeit not as much as I’d hoped: •  I combined the install pages for Windows, Linux and Mac into one, at the suggestion of @Mataniko. I agree that this is a better way to do it. •  First, second and third drafts of the Audio page. By far this is the most confusing subject for me, and I am forever indebted to @NMIError (and everyone who contributed this week) for all the information and corrections! I spent a fair bit of time on this one, as predicted, and there is still some information missing. I will continue with this next week.  •  First draft of the Cloud and LAN page. •  I took screenshots of the new v2.2 Launcher, although these are yet to be uploaded and changed on the Launcher/adding and playing...

Season of Docs: Week 3

  Wow, time flies when you’re having fun! Another week down. I’m mostly on track with my new timeline, this week: •  Tidied up the configuration file, command line and keyboard shortcuts pages and formatted a lot of these keywords into tables.   I ran into some difficulty here - turns out the Read the Docs theme has tables that are not responsive/do not use word wrapping, and instead have scroll bars on smaller screens. To enable word wrapping requires a custom css file, which in itself is easy enough to do (and works very well!), but apparently does not play nicely with the tabs extension...... I need to look into this issue a bit more and figure out a solution, because I do think the tables provide a nice way of displaying lists of information, provided they are formatted appropriately! •  First draft of the graphics page. Thanks to @criezy for the work you already did on this in the wiki User Manual, as well as the information you gave me on Discord. The on...