Yo! For three straight months I have been promising that that would be the last Symbol docs report... and I think this time it is finally true.

Symbol documentation is officially complete.

(Pending user guides for future products, my lawyer insists I add.)

So here you have one final report on the Symbol docs, the beginning of a new series of reports on the NEM docs, and... a return to game development mode :xymcoin:

Summary of Work Done

• Writing Content

  :symbol-shield: Spent the whole month going through the comments Jaguar made during his thorough review of the new Symbol docs site.

  Some comments pointed out technical issues (my fault!), others focused on style, and many were suggestions for improvement. In total, there were a lot of them.

  The review took considerably longer than I would have liked, but the docs are in a much better place now and are finally ready to become the official Symbol documentation.

  As one example, the Developer Manual landing page now categorizes tutorials by complexity, making it easier for newcomers to find an appropriate starting point.

• Review

  :nem-shield: Zero has started working on the new NEM docs site and I have been reviewing the work as it comes in. You can already see the work in progress here.

  The site follows the same structure as the new Symbol docs, with a User Manual, a Developer Manual, and a Textbook that complements both. The Textbook is already complete, and work has now shifted to the tutorials.

  Because the Symbol SDK supports both the Symbol and NEM blockchains, most NEM tutorials will be very similar to their Symbol counterparts, so I expect development to move quickly 🤞🏻

• Daruma

  :xymcoin: This month I managed to sneak in two whole days to work on the Game Design Document for XYM City.

  With the Symbol docs review finally wrapped up, I am hoping that number will increase considerably over the next few months... 💃🏻

• Site configuration

  ⚙️ Several of Jaguar's review comments required significant changes to the site's underlying infrastructure.

  There is a special kind of pain reserved for refactoring things that were supposed to be finished. But pain is temporary and git is forever, so I trudged on. The tutorial system now includes:

  • A complexity metadata tag that adds a label to each tutorial and automatically generates a sorted table on the Developer Manual landing page.
  • Named code snippets instead of line-number-based references, allowing source code to evolve without constantly updating snippet ranges.
  • Variable names in tutorial text that automatically adapt to the selected programming language. Method and class names already worked this way, but variables did not.

• Learning

  🤖 Hatchet has been encouraging us to get up to speed with modern AI-assisted workflows.

  I was already using ChatGPT extensively to review my writing (English is not my native language, sorry!), but this month I took the next step and installed Codex in VS Code.

  It turned out to be remarkably useful during the site refactoring work. Having an assistant that can understand the structure of the entire documentation repository is obviously a perk.

  That said, I am still keeping it on a fairly short leash. It may be a little paranoid, but I am not letting it commit anything without my review first.

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

Documentation Status

:symbol-shield: Symbol

The Symbol documentation is now officially complete. The only remaining work is preparing the site for publication at its final URL.

Of course, documentation is never truly finished, and new guides will be added as new products and features are developed.

I am posting one final progress chart because… look at those beautiful 100% bars 🥲

:nem-shield: NEM

Starting this month, I will be reporting on the NEM documentation instead.