#code documentation

For years, vroapi.com has been a favorite resource for VCF Operations Orchestrator (vRO) developers. However, since last few year, their original developers moved away to different fields which left the website unattended and troubled by certificate issues, outdated data, and lack of maintenance, leaving it almost impossible to use effectively. Enter (https://modernvroapi.in) – a complete…

Documenting Software Architecture When we need to explain to someone else (new developer, product owner, investor, …) how the application works, we need documentation. But what documentation options do we have that can express the whole application build

This post is part of The Software Architecture Chronicles, a series of posts about Software Architecture. In them, I write about what I’ve learned on Software Architecture, how I think of it, and how I use that knowledge. The contents of this post might make more sense if you read the previous posts in this series.

We learn how to code and we build some cool applications, and then we learn…

In my previous post in this series, I published an infographic that reflects the mental map I use to figure out the relationships between the code units types. But, there was something that was not very well reflected there...

This post is part of The Software Architecture Chronicles, a series of posts about Software Architecture. In them, I write about what I’ve learned on Software Architecture, how I think of it, and how I use that knowledge. The contents of this post might make more sense if you read the previous posts in this series.

In my previous post in this series, I published an infographic that reflects the…

It started with Linus Torvalds’, What a good commit message looks like (2011)

MaxwellBo’s fork includes emojis

To apply the template, save the above file to your local machine and use git config --global commit.template <.git-commit-template.txt file path>

For example, if you saved it to your home folder, try: git config --global commit.template ~/.git-commit-template.txt

References

A useful template for commit messages

How to Write a Git Commit Message

TheDocs – Online Documentation WordPress Theme (Software)

Live PreviewPurchase $49.00 TheDocs is a powerful, responsive, and high-performance html online documentation template which can help you rapidly develop your next software’s documentation. It can be used for documenting API, frameworks, plugins, templates, etc. It’s based on Bootstrap and contains a lot of components to easily make your interactive documentation. TheDocs comes with a simple…