Wow, this month has been all about grunt work. I am exhausted!

Summary of Work Done

• Writing content As expected, this month has been spent mostly writing the first pages for each of the three books, which will act as templates for all the remaining pages. These pages are important, so I’ve taken my time to uncover any potential issues early. I want to highlight some points:
  • :task-docs-user: User manual: Do you like the way to present the steps and the screen shots? Clicking on an image gives you the full screen version, while keeping the instructions. You can even follow the steps from the full screen with the left and right keys!
  • :task-docs-dev: Dev manual: You have code snippets in multiple languages, links to method and endpoint documentation, links have tooltips with quick docs (not working for all languages yet!), and a few behind-the-scenes improvements that should simplify more tutorials in the future.
  • :task-docs-textbook: Textbook: Textbooks are boring, people only reads them to learn about a particular topic and then leave, so I made sure important terms are highlighted in summary boxes. Links to these terms show the summary on hover! Try it out!
• Site configuration Almost all infrastructure is in place, I’ve just added features as I needed them to write the templates. Sometimes a plugin did the trick. Other times, I had to write some Python, Jinja, or HTML to get the effect I wanted.
• Management Almost no time spent on management this month! 🎉 I maintained the task list, prepared a presentation for our internal all-hooks meeting, and spent some time getting to know our AI helper, chadGPT, a bit better.

Here you have each task’s relative time distribution for this month:

Documentation Status

I plan to update the status of all documentation tasks each month. The main line to watch is Symbol Documentation at the top, with all other entries listed as its subtasks. The bars in the chart represent how many of those subtasks have been completed.

Up Next

The templates are done! With those in place, I can start writing content pages and should soon reach cruising speed.

At the same time, I’ll keep working on a few infrastructure tasks: fixing tooltips that do not work for all links, adding Java documentation once the SDK is more advanced, and making method links adapt to the selected language, among others.

Last month I introduced Daruma Studios. Unfortunately, I did not have time to work on it this month. But my mind keeps racing with ideas I’d love to try out. Definitely stay tuned!

Thanks for reading this far, and see you next month!

—

Xavi