#qlova

Yesterday, the Qlovaseed documentation was tested for the first time (Qlovaseed is an app-development framework I am working on). Completely unprompted, my girlfriend tried using the framework and stumbled right into an issue. She couldn’t display an image in an app she created.

To add an image to an app, you need to have it in an ‘assets’ directory inside your project.

image.AddTo(App, "image.png") //This loads the image ./assets/image.png

The fact that this issue came up, clearly shows that the current documentation is inadequate (There are plenty of other undocumented features of the framework).  Software frameworks that are written in Go (and hosted on GitHub) have their documentation automatically generated on godoc.org. Sourced from comments made by the developer within the code. For large projects though, Godoc has some pretty apparent weaknesses. Take a look at the GitHub API documentation:

Currently, Qlovaseed is using Godoc and while it may be great as a quick API reference. An app-development framework needs something better. Perhaps Sphinx, which I discovered because it powers the documentation for the Godot game engine (which I have been impressed by before).

Sphinx offers free documentation hosting for open-source projects and allows documentation to be written for a project in a custom format. I am currently investigating Spinx along with my team to establish whether or not it is a good choice for the Qlovaseed documentation.

I finally got around to creating a website for Qlova, the organization that holds ownership of the ‘i’ programming language and island. I ended up employing my Css and Javascript skills to create a fully animated webpage.