Jan-Lukas Else

Tech, life and everything else

Tackling a long overdue task

Published on in 💭 Thoughts
Short link: https://b.jlel.se/s/81a
Share this post
⚠️ This entry is already over one year old. It may no longer be up to date. Opinions may have changed.

Given that AI agents and GitHub Copilot is an integral part of my work day nowadays, I decided to tackle a massive task I neclected for too long. AI should now help me with it: writing entirely new and better documentation for GoBlog.

I think a big reason for people looking at GoBlog, but even when interested, not using it, is because the documentation is so bad. Almost nothing is documented; the README is just a link to the docs page, and the blog is out-of-date. Every time someone is contacting me about GoBlog, it’s because they have questions a good documentation should be able to answer.

Writing documentation is a tedious task, something I always prioritized below implementing new features and ideas. Nothing is wrong with that approach, as it’s a hobby project after all, but it destroys the potential of GoBlog as a simple blogging platform everyone can put on a server and start blogging with it. And it also prevents people from actually contributing to the project.

Due to some changes at work, I only do paid work for 36 hours per week for now, so I have 4 hours left to work on my own projects, improve them, and maybe learn new things and tools along the way. ☺️ Next to improving GoBlog’s documentation, I will also use it to get more familiar with Angular and Spring Boot.

This post should act like some public commitment to hold me accountable for. 😅

Tags:

Jan-Lukas Else
Interactions & Comments