Posts

Showing posts from November, 2020

Season of Docs: Week 9 and 10

 Hi everyone, Sorry this one is reaching you a little late (and the post for week 10 a little early). I must say there hasn’t really been anything exciting to report! We’re at the pointy end of it now, all the content is there but now is the fun part (not...) - proofreading, editing, and more editing! Every page is at the final draft stage now, so please send me any feedback, any mistakes you find, anything at all. It should all be correct! I’ve played around with the look of the site, just a few colour changes and it’s looking much more on-brand. I also finally mostly figured out the PDF output. Who sets the default font to Times New Roman in this day and age?! I’d prefer the body of the text to be sans serif but I haven’t quite worked out how to do that yet... I’m away and out of reception for the next 4 days, but I’ll receive any messages on Discord once I’m back in civilisation.  As always, draft site at scummvm-documentation.rtfd.io  See you soon, Cadi

Season of Docs: Week 8

  Hi everyone, It was a nicely productive week - due to rostering changes at my day job, I got an extra day off to work on this project!   This past week: •  Added port pages as I received information. Thank you to those developers who reached out and answered my questions, I really appreciate it! Also a shoutout to user @IlDucci  who was my guinea pig for the Vita, PSP and especially the Dreamcast.  •  Tweaked the FAQ; added a table of contents, general edits.  •  Proofread/edited most of the pages for consistency and compliance with the Google style guide. •  Completed a draft of the contribution guide for technical writers. With a few minor changes to be made, this will find its way into the wiki in the coming days. •  Redesigned the landing page with a handy Bootstrap plugin. I quite like the result but feedback welcome as always.  •  Fixed and then broke and then fixed the tables (again). Sphinx builds on Read the Docs can be a bit finnicky to say the least....  •  Pla

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