Skip to content

Commit b554642

Browse files
denisecasedenisecase
committed
Prep v0.1.0
1 parent 5215384 commit b554642

13 files changed

Lines changed: 150 additions & 5 deletions

File tree

‎.markdownlint.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# ============================================================
2+
# .markdownlint.yml (Markdown linting rules)
3+
# ============================================================
4+
# Updated: 2026-04-22 (Structural Explainability)
5+
# WHY: Enforce consistency without blocking intentional patterns
6+
# used in documentation (redirects, badges, collapsible sections).
7+
8+
default: true
9+
10+
MD013:
11+
line_length: 100
12+
headings: false
13+
tables: false
14+
code_blocks: false
15+
16+
MD025: false
17+
18+
MD033:
19+
allowed_elements:
20+
- meta
21+
- link
22+
- details
23+
- summary

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22

33
[![Docs Site](https://img.shields.io/badge/docs-site-blue?logo=github)](https://structural-explainability.github.io/se-constitution/)
44
[![Repo](https://img.shields.io/badge/repo-GitHub-black?logo=github)](https://github.com/structural-explainability/se-constitution)
5+
[![Python 3.15+](https://img.shields.io/badge/python-3.15%2B-blue?logo=python)](./pyproject.toml)
6+
[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE)
57
[![CI](https://github.com/structural-explainability/se-constitution/actions/workflows/ci-python-zensical.yml/badge.svg)](https://github.com/structural-explainability/se-constitution/actions/workflows/ci-python-zensical.yml)
68
[![Docs](https://github.com/structural-explainability/se-constitution/actions/workflows/deploy-zensical.yml/badge.svg)](https://github.com/structural-explainability/se-constitution/actions/workflows/deploy-zensical.yml)
79
[![Links](https://github.com/structural-explainability/se-constitution/actions/workflows/links.yml/badge.svg)](https://github.com/structural-explainability/se-constitution/actions/workflows/links.yml)
8-
[![Python 3.15+](https://img.shields.io/badge/python-3.15%2B-blue?logo=python)](#)
9-
[![License](https://img.shields.io/badge/license-MIT-yellow.svg)](./LICENSE)
1010

11-
> Structural Explainability constitution: governing rules, schemas, and validation for the SE ecosystem.
11+
> Structural Explainability constitution:
12+
> rules, schemas, and validation for the SE ecosystem.
1213
1314
## Command Reference
1415

1516
<details>
1617
<summary>Show command reference</summary>
1718

18-
### In a machine terminal (open in your `Repos` folder)
19+
### In a machine terminal
1920

2021
After you get a copy of this repo in your own GitHub account,
21-
open a machine terminal in your `Repos` folder:
22+
open a machine terminal in `Repos` or where you want the project:
2223

2324
```shell
2425
# Replace username with YOUR GitHub username.
@@ -47,6 +48,7 @@ uvx pre-commit run --all-files
4748
uv run python -m se_constitution validate
4849

4950
# do chores
51+
npx markdownlint-cli "**/*.md" --fix
5052
uv run python -m ruff format .
5153
uv run python -m ruff check . --fix
5254
uv run python -m pyright

‎docs/en/class/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Class Registry
2+
3+
Defines repository classes and their structural meaning.
4+
5+
## Purpose
6+
7+
- establish canonical repo classes
8+
- provide shared vocabulary across artifacts
9+
10+
## Source
11+
12+
- `class-registry.toml`

‎docs/en/dependency/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Dependency Rules
2+
3+
Defines allowed relationships between repository classes.
4+
5+
## Purpose
6+
7+
- constrain cross-repo dependencies
8+
- enforce structural layering
9+
10+
## Source
11+
12+
- `dependency-rules.toml`

‎docs/en/examples/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Examples
2+
3+
Concrete instances of Structural Explainability artifacts.
4+
5+
## Purpose
6+
7+
- illustrate valid structures
8+
- support testing and adoption

‎docs/en/glossary/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Glossary
2+
3+
Canonical definitions for Structural Explainability terms.
4+
5+
## Purpose
6+
7+
- eliminate ambiguity
8+
- support consistent interpretation

‎docs/en/index.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Structural Explainability Constitution
2+
3+
Canonical specification and validation framework for Structural Explainability.
4+
5+
## Artifacts
6+
7+
- [Class Registry](./class/)
8+
- [Dependency Rules](./dependency/)
9+
- [Naming Patterns](./naming/)
10+
- [Manifest Schema](./manifest/)
11+
- [Repository Requirements](./repo/)
12+
13+
## Supporting
14+
15+
- [Law](./law/)
16+
- [Jurisdiction](./jurisdiction/)
17+
- [Glossary](./glossary/)
18+
- [Examples](./examples/)

‎docs/en/jurisdiction/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Jurisdiction
2+
3+
Defines applicability context for rules and artifacts.
4+
5+
## Purpose
6+
7+
- scope where rules apply
8+
- separate domains and contexts

‎docs/en/law/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Law
2+
3+
Normative rules governing Structural Explainability artifacts.
4+
5+
## Purpose
6+
7+
- define constraints
8+
- support validation logic

‎docs/en/manifest/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Manifest Schema
2+
3+
Defines required structure for `SE_MANIFEST.toml`.
4+
5+
## Purpose
6+
7+
- standardize repository declarations
8+
- enable validation and interoperability
9+
10+
## Source
11+
12+
- `manifest-schema.toml`

0 commit comments

Comments
 (0)