Skip to content

ostis-ai/ostis-metasystem

Repository files navigation

ostis-metasystem

CI license

Quick Start Docs Community

This repository is a storage of the Metasystem of the OSTIS Technology.

OSTIS Metasystem contains:

  1. OSTIS Metasystem knowledge base;
  2. OSTIS Metasystem problem solver;
  3. OSTIS Metasystem user interface.

To learn more about the OSTIS Metasystem, check out our documentation.

Getting started

To get started, check out our quick start guide.

Documentation

  • A brief user manual and developer docs are hosted on our GitHub Pages.

    • Build documentation locally
      pip3 install mkdocs mkdocs-material
      mkdocs serve
      # and open http://127.0.0.1:8001/ in your browser
  • Documentation about implementation of components is located in docs/main.pdf file of this project.

    • Build documentation locally
      • Build steps (using LaTeX)

        cd docs
        TEXINPUTS=./scn: latexmk -pdf -bibtex main.tex
      • Build steps (using Docker)

        docker run -v ${PWD}:/workdir --rm -it ostis/scn-latex-plugin:latest "docs/main.tex"
      • Download scn-tex-plugin and documentation for subprojects

        After the compilation, the main.pdf file should appear at ostis-metasystem/docs/. You can find more information about scn-latex-plugin here.

Feedback

Contributions, bug reports and feature requests are welcome! Feel free to check our issues page and file a new issue (or comment in existing ones).

License

Distributed under the MIT License. Check COPYING.MIT for more information.