Summary of Work Done

• Review of an upcoming book about Symbol Opening Line is preparing a book about creating applications using the Symbol blockchain and asked me to review it. Though challenging, especially since the book is in Japanese, a language in my TODO list, the work has been rewarding. The book's hands-on approach is very appealing to me, and I learned quite a bit during the review process.
• Site configuration I've selected MkDocs and Material as the static site generator for the documentation, and I'm now configuring the required plugins. The challenge is that these plugins don't always work well together, especially since we need API documentation for multiple languages (Python, TypeScript, Java, and REST) and no single tool can handle them all. I'm using mkdocstrings, Typedoc, Doxygen, and Swagger-ui-tag, with tooltips now functioning. The current focus is on unifying the theme to make everything look more cohesive. This project involves quite a bit of coding, and I'm actually grateful for that, as I've really missed it! I can't wait to start writing the tutorials!
• Management Nobody likes management, but you can’t scape it ¯\(ツ)/¯ Writing a job description and interviewing possible writers, creating tasks lists… The upside is that now we have the list of all pages that we want to create! Check out the next section.
• Writing content There hasn’t been much of that this month, but there has been activity around the OpenAPI spec for the old NEM NIS1 REST API. Yes, the focus is on Symbol docs, but NEM is not forgotten.

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

Once I have the site completely setup I’ll share it with you and hit full throttle on the content writing part, hopefully keeping management and site configuration to a minimum. Then, after we onboard more writers, my time should be split between writing and reviewing.

Site Map

Here's the list of all pages we plan to create for the Symbol docs (click to expand them).

Some pages already exist, others have tutorial code we can use as a foundation, and the rest will need to be written from scratch.

<aside> 🔥

This is your chance to ask for anything you want!

Review the lists below and let us know if you spot anything you think is missing!

Contact information is in the front page of this blog.

</aside>

User Manual

Learn to do stuff without coding.

Developer Manual

Learn to do stuff by coding.

Textbook

Learn how stuff works.

Up Next

Finish fine-tuning the site and publish a proof-of-concept to gather feedback.

Write the first page for each of the books, to set the style and use as templates.

Then… write, write, write, hire someone else, and write, write, write.

Thanks for reading this far! See you next month!