Documentation

screenshot of Documentation

Repo for hosting BHoM documentation. :mortar_board: The markdown files get reflected into a webpage via mkdocs and GitHub actions.

Overview

BHoM Documentation serves as a valuable resource for users looking to understand and utilize the Building Habitat's Object Model (BHoM). This repository is designed to host comprehensive documentation that facilitates navigation through various features, ensuring that users can easily access the information they need. With a streamlined structure, it aims to enhance the overall user experience and provide clarity on the functionalities of BHoM.

Features

  • Comprehensive Coverage: The documentation encompasses a wide range of topics related to BHoM, making it a one-stop solution for users at any level of expertise.
  • User-Friendly Navigation: Easily navigate through sections to find specific information or concepts, streamlining the learning process.
  • Clear Editing Guidelines: Includes information on how to contribute to or edit the documentation, encouraging community collaboration and continuous improvement.
  • Regular Updates: The documentation is frequently updated to reflect the latest developments in BHoM, ensuring users have access to the most current information.
  • Accessible Information: Designed to be user-friendly and accessible, the documentation can be utilized by anyone interested in learning about BHoM.
  • Visual Aids: Incorporates diagrams and visuals to enhance understanding of complex concepts, adding an extra layer of clarity for users.