The modern software stack in many organizations consists of serverless, distributed systems and microservices on cloud platforms. This brings many benefits in terms of flexibility, availability, and cost. However, the downside is that these systems are highly dynamic and challenging to keep track of.

We at BVAI, are in the process of building our documentation where we take advantage of collaborative platforms like GitHub.

The Repository

We’ve selected GitHub as our documentation platform for its simplicity in fostering collaboration and maintaining version control. This repository ensures smooth teamwork and clear tracking of document changes, enhancing our ability to provide comprehensive documentation for SnapApp.

You can find the repository from here: github.com/BlueVector-AI/SnapApp-Docs

With GitHub, we can seamlessly leverage VS Code directly from the browser for editing and collaboration. Simply press ‘.’ (period) while on a file in the repository to instantly open it in VS Code.

Go ahead with writing documentation from the web! And once you are done, time to commit your changes.

Look for the develop branch on your bottom left. Choose Create a new branch, and add a name.

From the taskbar, choose Source Control and add a commit message. Then click Commit & Push

Follow this tutorial on how to create a Pull Request

What did you learn today

Today, in under 2 minutes you learnt about our documentation repository and how to get started with it.