Skip to content

RQM-Technologies-dev/rqm-docs

Repository files navigation

rqm-docs

Official documentation hub for the current RQM Technologies stack.

This site is built with MkDocs and the Material theme and is deployed from this repository.

Canonical docs URL: https://docs.rqmtechnologies.com/


Scope

rqm-docs documents the current platform layers reflected in this site:

  • rqm-core — mathematical spine
  • rqm-compiler — internal optimization and rewriting engine
  • rqm-api — canonical service boundary
  • rqm-studio — visual and workflow layer
  • rqm-docs — documentation layer

How to Run Locally

pip install -r requirements.txt
mkdocs serve

The site will be available at http://127.0.0.1:8000.

To build the static site:

mkdocs build --strict

Output is written to the site/ directory (excluded from version control).


Deployment

The site is built and deployed by the GitHub Actions workflow in .github/workflows/deploy.yml.

About

RQM ecosystem documentation to include guides, concepts, architecture, and API references for rqm-core, rqm-qiskit, and rqm-notebooks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages