Home Inc. API Guidelines

This project contains API Guidelines for Home Inc. The documentation is built with https://vitepress.dev.

Getting Started

This project uses Gitlab Pages for deployment.

To preview the documentation locally, follow these steps:

1. Install the dependencies:

npm install

2. Run the development server:

npm run dev

This will start a local server at http://localhost:5173/ where you can view the documentation.

GitHub Pages

Currently the content is being deployed to https://kamax7c0.github.io/api-guidelines

Contributing

Contributions to this project are very welcome! To contribute, please use merge requests.