README.md

BĮIP Project Documentation

Welcome to the official documentation for the BĮIP project.

Table of Contents

• Getting Started
  • Installation
  • Usage
• Deployment
• Contributing
• License

Getting Started

If you're new to the BĮIP documentation, here's how to get started:

Installation

1. Clone the repository:

   git clone https://github.com/AplinkosMinisterija/biip-docs.git

2. Ensure you have Rust and Cargo installed. You can follow the instructions on the Rust installation page.

3. Install mdbook and required dependencies:

   cargo install mdbook mdbook-mermaid mdbook-linkcheck

Usage

To use the documentation:

1. Preview documentation (additional commands in package.json):

   mdbook serve

Deployment

Preview

Each commit automatically creates a new preview environment on pull requests to the main branch.

Production

Each commit to main branch automatically creates deployment to production environment.

Contributing

We welcome contributions! If you encounter issues or have suggestions for improvements, feel free to open an issue or submit a pull request. For more information, please refer to the contribution guidelines.

License

This project is licensed under the MIT License.