This project was created in response to the ever-growing README.MD file and the increasing size of the Allor repository due to images.
It was decided to dedicate a separate project solely for documentation.
This also facilitates a more convenient and faster addition/modification of information about Allor’s modules and nodes.
Allor Documentation is automatically built after each update using GitHub Actions and is deployed on GitHub Pages.
Manual builds from the terminal/console or in IDEs other than Writeside are not currently supported.
Contributions to Allor Documentation are welcome and appreciated. Here are a few ways you can contribute:
- Proofreading: Help us correct typos, grammatical errors, and inconsistencies in the documentation.
- Improving clarity: Help us make our documentation clearer and more accessible.
- Providing examples: Help us improve our documentation by providing or improving examples.
- Keeping documentation up-to-date: Help us keep our documentation current as the project evolves.
- Improving structure and navigation: Help us improve the structure and navigation of our documentation.
To get started, please fork this repository, make your changes, and submit a pull request. We look forward to your contributions!