https://github.com/structural-explainability/site

Documentation site for Structural Explainability.
https://github.com/structural-explainability/site

documentation explainability formal-methods specifications structural-explainability

Last synced: about 1 month ago
JSON representation

Documentation site for Structural Explainability.

• Host: GitHub
• URL: https://github.com/structural-explainability/site
• Owner: structural-explainability
• License: mit
• Created: 2025-12-28T17:35:42.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2026-01-23T17:56:57.000Z (4 months ago)
• Last Synced: 2026-01-24T07:52:36.903Z (4 months ago)
• Topics: documentation, explainability, formal-methods, specifications, structural-explainability
• Homepage: https://structural-explainability.github.io/site/
• Size: 651 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Site: Structural Explainability

[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)

[![Deploy Docs](https://github.com/structural-explainability/site/actions/workflows/deploy-docs.yml/badge.svg?branch=main)](https://github.com/structural-explainability/site/actions/workflows/deploy-docs.yml)

![Build Status](https://github.com/structural-explainability/site/actions/workflows/ci-hygiene-mkdocs.yml/badge.svg?branch=main)

[![Check Links](https://github.com/structural-explainability/site/actions/workflows/links.yml/badge.svg)](https://github.com/structural-explainability/site/actions/workflows/links.yml)

[![Dependabot](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg)](https://github.com/structural-explainability/site/security/dependabot)

> Documentation site for Structural Explainability.

This repository hosts the public-facing site built with MkDocs and deployed

via GitHub Pages. It is docs-only and does not produce a Python package.

## Developer

Steps to run pre-commit locally. Install `uv`.

Initialize once:

```shell

uv self update

uv python pin 3.12

uv sync --extra dev --extra docs --upgrade

uvx pre-commit install

git add -A

uvx pre-commit run --all-files

```

Build and serve docs:

```shell

uv run mkdocs build --strict

uv run mkdocs serve

```

Save progress as needed:

```shell

git add -A

# If pre-commit makes changes, re-run `git add -A` before committing.

git commit -m "update"

git push -u origin main

```

## Annotations

[Annotations.md](./ANNOTATIONS.md)

## License

[MIT](./LICENSE)