Hey! This has been another exhausting month working nonstop to finish the docs… and we did it. The new Symbol docs are just a couple weeks away!
We hit another record in tutorial output, and the progress plots are getting a bit ridiculous.
As a side effect of two straight months focused entirely on documentation, I am very ready to jump back into XYM City. My brain is about to explode 😄 Notes are piling up everywhere: Google Drive, Notion, text files, my phone, even Post-its on my nightstand.
But first, one last boring report, just plots, no screenshots. Hopefully the last one 😁
Writing Content
:task-docs-dev: Wrote tutorials on mosaic restrictions and network time.
:task-docs-user: Wrote several smaller pages, including the security page, which is linked from the wallet, and started working on Shoestring guides to deploy and maintain nodes.
Review
:task-docs-dev: Zero delivered new tutorials on proving that transactions and mosaics are defined on-chain as reported by nodes, along with several more on WebSockets programming.
All of them were reviewed and published.
:nem-shield: After the full rewrite of the NIS1 REST OpenAPI spec the previous month, CryptoBeliever moved on to the Symbol OpenAPI spec. This time: 430 files, 6650 lines of YAML. It has been 4 weeks of back-and-forth review, and we’re almost done!
Management
With the deadline to finish the docs approaching, it was time to decide which pages would make this release and which would have to wait. You can see the final decision below.
Site configuration
Worked on a few pending tweaks to the docs site: added links to the serialization tables, removed the Java SDK from the reference pages (it is not ready), improved link contrast in the light theme, and fixed a few remaining bugs.
Here you have each task’s relative time distribution for this month:
This is the current status of all documentation tasks. 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. The change since last month is shown in orange.
Woohoo! Look at all those tutorial categories at 100%! In fact, the Analytics and Bridge tutorials have been moved to a post-release stage, so the only remaining tutorials are cross-chain transactions, which are already sitting on my desk waiting for review.
The reference guides only need their links redirected from the old docs to the new pages.
The remaining tasks in the infrastructure category are all related to publishing the new docs and ensuring things like Continuous Integration keep working with the new URL.
And finally, the User Manual. It is sitting at about 30% complete, mainly due to the Shoestring guides that are still in progress, and because development of the new wallet and explorer is not far enough along yet.
So! With 85% of the planned Symbol documentation already complete, these docs should become official very, very soon! The next status update should look very different 😁