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 only thing missing from this at the moment is information around OpenGL, which I will admit I don’t have a full understanding of. I will ask some questions this coming week.


•  I did not do any work around control mapping - most likely this will find its way into the settings pages now, since Keymaps has its own settings tab in version 2.2.0.


Updated timeline for the next couple of weeks:


Week 4:

Using ScummVM:

•  Global/general settings - Update with version 2.2.0 Keymaps information.

•  Adding and playing games - Update with version 2.2.0 screenshots.

•  Launcher - Update with version 2.2.0 screenshots.

•  Cloud and LAN - First draft. 

Advanced Options:

•  Graphics - Add information about OpenGL

•  Audio - A deeper dive into how this all works; first draft. I feel like this one might take a bit of time!!


Week 5:


Using ScummVM:

•  Saving and loading games - I’ve decided to create a dedicated page for this; first draft

_Help:

•  FAQ - first draft.

•  Known problems - first draft.

•  Reporting a bug - first draft.

•  Contacts


By the end of Week 5 (all going well) I should have the bulk of information in place, although there will still be significant work around fact-checking, proofreading, editing and so on. I anticipate this to be ongoing until the end of the project.  


Some next steps that were not in my original proposal would be a “Getting Involved” section with information around how to contribute to both code and documentation. I also want to revisit the port-specific information, and get as many ports documented as possible once everything else is in place. 


As always, documentation is available to view at https://scummvm-documentation.readthedocs.io/en/latest/


I love hearing from you and learning as much as I can, so keep it coming. If there’s anything you think is missing, please let me know and I’ll make sure to include it in the docs. 


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 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

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