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 games pages. I will most likely get this done tonight.


My timeline for the next couple of weeks, which unfortunately has some carryover items:


Week 5

_Advanced Options:

•  Audio - add sections about output sample rate and using compressed audio files.

•  Graphics - add information about OpenGL  

•  Configuration file - I think there are some audio options missing here, add these and split into [scummvm] and [game] categories. 

Using ScummVM:

•  Global/game settings - add v2.2 keymaps information.

•  Saving and loading games - new page, first draft.


Week 6

Help:

•  FAQ - first draft.

•  Known problems - first draft.

•  Reporting a bug - first draft.

•  Contacts


Docs-in-progress are available at scummvm-documentation.readthedocs.io, merged docs at docs.scummvm.org.


Thanks for all your support and as always, see you on Discord.


Cadi











Comments

Post a Comment

Popular posts from this blog

Season of Docs: Project Report - Launch a Documentation Portal

  Project report: Launch a documentation portal •    The original proposal is available  here . •    The finished project, which will remain unchanged, is available  here . •    The live documentation is available  here . •   P ull requests available here  . The objectives The objectives, as set out in the project proposal: 1.    To produce high-quality, versioned end user documentation by consolidating large amounts of information from disparate sources and re-writing information for clarity, consistency, and completeness. Documentation should be easy to understand for beginners, without being patronizing to tech-savvy users. 2.     To create a documentation portal using a static-site generator. 3.    To future-proof end user documentation by creating templates and detailed how-to instructions for future open source contributors. The outcomes The completed documentation portal comfortably meets all the objectives: •    It is easy to follow, easy to navigate and pulls a large amount of
Read more

Season of Docs: Week 7

  What I accomplished during week 7: •  Started an FAQ. It’s got the basics, but I need more! Please keep the questions coming, I’ve only had two responses.... Link to Google Form her e . The FAQ still has formatting issues and definitely some grammar/spelling issues, so don’t judge too harshly (yet).  •  Created an “Other platforms” section, containing port-specific guides according to the agreed structure. I think they work quite well. •  Replaced the GIFs on the iOS page. I’m much happier with how they are now. Feedback on the use of GIFs vs screenshots would be appreciated. •  Added a “Release notes” section.  •  Moved extra information out of the Settings pages and into a new “Guides” section.  •  Got very, very confused by Git. At least now I (kind of) understand how to rebase. I think. Maybe.  I had a meeting with @mataniko this morning, and we discussed how to go about setting minimum requirements for documentation moving forward. It’s been decided that a new “documenta
Read more

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 settings pages as
Read more