vAMSYS Documentation

Welcome to the vAMSYS Documentation Project. This repository hosts the content for the documentation website available at docs.vamsys.dev

Overview

This project provides comprehensive documentation for the vAMSYS platform, including user guides, API references, and tutorials to help users get the most out of the system.

The app folder contains the primary code for the documentation website, including various components, pages, and other resources. We welcome contributions to this folder in the form of pull requests.

Contributing

If you have suggestions, corrections, or improvements for the documentation website, feel free to submit a pull request. Please ensure you follow the guidelines below before contributing:

Steps to Contribute

1. Fork the repository.
2. Clone your fork to your local machine:

   git clone https://github.com/vAMSYS-LTD/documentation.git

3. Navigate to the app folder and make the necessary changes:

   cd app

4. After making your changes, commit them to your local branch:

   git add .
   git commit -m "Describe your changes here"

5. Push your changes to your forked repository:

   git push origin main

6. Open a pull request from your fork to this repository.

Contribution Guidelines

• Please ensure that any changes you make to the app folder are focused on improving the documentation website, such as fixing errors, improving clarity, or adding new content.
• For bug fixes, please provide a detailed description of the problem and how your change resolves it.
• Make sure your code adheres to the style and structure of the existing project.