FIRO documentation

This repository contains the documentation for the FIRO project. The documentation is written in Markdown format and stored in the docs folder. The documentation is automatically published on the website.

Editing the Documentation

To edit the documentation, you can use any text editor that supports Markdown syntax. We recommend using Obsidian as it provides an intuitive editing experience and allows you to treat the docs folder as a vault

If you prefer to use a different editor, please ensure that you adhere to the Markdown syntax supported by Obsidian to maintain compatibility with our documentation system.

Here's a step-by-step guide to editing the documentation:

1. Clone the repository to your local machine.
2. Open the docs folder in your preferred text editor or Obsidian.
3. Create or modify Markdown files within the docs folder to add or update documentation content. Create subfolders within the docs folder to organize the documentation,
4. Save and publish your changes

Publishing Changes

Once you have made your changes to the documentation, you can publish them by following these steps:

1. Commit your changes: Use Git to commit your changes locally. If you're new to Git, you can refer to Git - The Simple Guide for a beginner-friendly guide on Git basics.
2. Push your changes: Push your committed changes to the repository's main branch.
3. Wait for the update: It may take a few minutes to reflect the changes on the website as the CI/CD process completes.

Additional Resources

If you choose to use Obsidian for editing the documentation, here's some additional information:

• Download Obsidian: Download from official Obsidian website
• Obsidian Help Center: Documentation and guides that can help If you're new to Obsidian or want to learn more about its features
• Obsidian Flavored Markdown: Learn about the specific Markdown syntax used by Obsidian.

If you are new to Markdown or Git, here are some additional resources that can assist you:

• Markdown Guide: A comprehensive guide to Markdown syntax.

• Git - The Simple Guide: A beginner-friendly guide to understanding the basics of Git version control.