From d0fe7324370d4826df80f4b691288da317e3c5e7 Mon Sep 17 00:00:00 2001 From: Denis Chevalier Date: Tue, 11 Aug 2026 11:45:44 +0200 Subject: Update README tree and rename LLM{_,-}POLICY.md --- LICENSE.md | 2 +- LLM-POLICY.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ LLM_POLICY.md | 60 ----------------------------------------------------------- README.md | 33 +++++++++++++------------------- 4 files changed, 74 insertions(+), 81 deletions(-) create mode 100644 LLM-POLICY.md delete mode 100644 LLM_POLICY.md diff --git a/LICENSE.md b/LICENSE.md index d4674a7..eb4201c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -66,7 +66,7 @@ licenses (`CC-BY-SA-4.0`, `CERN-OHL-S-2.0+`, `GPL-3.0-or-later`). strong copyleft, attribution, and source-sharing requirements of the respective licenses. * **Contributor AI Policy:** For rules regarding human contributor usage of AI - tools during submission, refer to [`LLM_POLICY.md`](LLM_POLICY.md). + tools during submission, refer to [`LLM-POLICY.md`](LLM-POLICY.md). ## Summary of SPDX Identifiers diff --git a/LLM-POLICY.md b/LLM-POLICY.md new file mode 100644 index 0000000..ecee3bc --- /dev/null +++ b/LLM-POLICY.md @@ -0,0 +1,60 @@ +# Policy on Artificial Intelligence & Large Language Models (LLMs) + +The **SAME Analog Modular Ecosystem** is built on mathematical rigor, executable +verification, and total human accountability. While AI tools and Large Language +Models (LLMs) are widely used in modern development workflows, their integration +into this project is governed by strict boundaries to maintain technical +integrity and clear ownership. + +## 1. Code & Specification Generation + +The use of LLMs as personal assistance tools (copilots, syntax helpers, or +drafting assistants) is **permitted**, subject to two non-negotiable conditions: + +### A. Manual Human Submissions Only + +**No AI Bots or Automated PRs:** Every pull request must be authored, reviewed, +and manually submitted by a human contributor. Automated PR bots, LLM agent +pipelines, or machine-generated submissions will be closed instantly. + +### B. Absolute Human Responsibility + +* **You Own Every Line:** The creator of a PR is 100% accountable for all text, + math, equations, CAD graphics, and code contained within their submission. +* **Must Defend the Engineering:** You must be capable of answering granular + technical, mathematical, and architectural questions about your submission + during code review. +* **Zero-Tolerance Excuse:** Defending a bug, broken assertion check, or flawed + physics model with *"the AI generated it"* is considered an admission that you + do not understand your own PR. Such PRs will be rejected immediately. + +## 2. Discussions & Communication + +Human-to-human clarity is vital when debating precision metrology and hardware +specs. + +* **No AI-Generated Comments or Reviews:** The use of LLMs to generate issue + responses, PR reviews, technical debate, or general commentary is **strictly + prohibited**. Discussion threads must reflect genuine human reasoning. +* **Translation Exception:** Non-native English contributors are permitted to + use machine translation to write PR descriptions, issue reports, or comments. + * *Recommendation:* We strongly recommend using dedicated translation tools + (e.g., DeepL) rather than general-purpose conversational LLMs to avoid + hallucinations, fluff, or loss of technical precision. + +## 3. Ban on AI Scraping & Ingestion + +**The SAME ecosystem repository is explicitly NOT parseable for commercial or +general AI training.** + +Under the terms of our multi-scope copyleft licensing model (**CC BY-SA 4.0**, +**CERN-OHL-S 2.0+**, **GPLv3**): + +* **No Automated Ingestion:** AI web crawlers, data scrapers, and model training + pipelines are strictly prohibited from ingesting, parsing, or harvesting the + text, code, metrology models, or CAD assets in this repository for model + training without complying with the full copyleft and attribution requirements + of the respective licenses. +* **Text & Data Mining Rights Reserved:** To the maximum extent permitted by + applicable law, the authors explicitly reserves all text and data mining (TDM) + rights regarding the documentation and specifications. diff --git a/LLM_POLICY.md b/LLM_POLICY.md deleted file mode 100644 index ecee3bc..0000000 --- a/LLM_POLICY.md +++ /dev/null @@ -1,60 +0,0 @@ -# Policy on Artificial Intelligence & Large Language Models (LLMs) - -The **SAME Analog Modular Ecosystem** is built on mathematical rigor, executable -verification, and total human accountability. While AI tools and Large Language -Models (LLMs) are widely used in modern development workflows, their integration -into this project is governed by strict boundaries to maintain technical -integrity and clear ownership. - -## 1. Code & Specification Generation - -The use of LLMs as personal assistance tools (copilots, syntax helpers, or -drafting assistants) is **permitted**, subject to two non-negotiable conditions: - -### A. Manual Human Submissions Only - -**No AI Bots or Automated PRs:** Every pull request must be authored, reviewed, -and manually submitted by a human contributor. Automated PR bots, LLM agent -pipelines, or machine-generated submissions will be closed instantly. - -### B. Absolute Human Responsibility - -* **You Own Every Line:** The creator of a PR is 100% accountable for all text, - math, equations, CAD graphics, and code contained within their submission. -* **Must Defend the Engineering:** You must be capable of answering granular - technical, mathematical, and architectural questions about your submission - during code review. -* **Zero-Tolerance Excuse:** Defending a bug, broken assertion check, or flawed - physics model with *"the AI generated it"* is considered an admission that you - do not understand your own PR. Such PRs will be rejected immediately. - -## 2. Discussions & Communication - -Human-to-human clarity is vital when debating precision metrology and hardware -specs. - -* **No AI-Generated Comments or Reviews:** The use of LLMs to generate issue - responses, PR reviews, technical debate, or general commentary is **strictly - prohibited**. Discussion threads must reflect genuine human reasoning. -* **Translation Exception:** Non-native English contributors are permitted to - use machine translation to write PR descriptions, issue reports, or comments. - * *Recommendation:* We strongly recommend using dedicated translation tools - (e.g., DeepL) rather than general-purpose conversational LLMs to avoid - hallucinations, fluff, or loss of technical precision. - -## 3. Ban on AI Scraping & Ingestion - -**The SAME ecosystem repository is explicitly NOT parseable for commercial or -general AI training.** - -Under the terms of our multi-scope copyleft licensing model (**CC BY-SA 4.0**, -**CERN-OHL-S 2.0+**, **GPLv3**): - -* **No Automated Ingestion:** AI web crawlers, data scrapers, and model training - pipelines are strictly prohibited from ingesting, parsing, or harvesting the - text, code, metrology models, or CAD assets in this repository for model - training without complying with the full copyleft and attribution requirements - of the respective licenses. -* **Text & Data Mining Rights Reserved:** To the maximum extent permitted by - applicable law, the authors explicitly reserves all text and data mining (TDM) - rights regarding the documentation and specifications. diff --git a/README.md b/README.md index 67ae748..790e82e 100644 --- a/README.md +++ b/README.md @@ -36,31 +36,24 @@ rigorous topological error compensation. ## Repository Structure -```text -. -├── charts/ # Vector charts built with CeTZ-plot -├── diagrams/ # Vector technical drawings & CAD layouts (CeTZ / Zap) -├── lib/ # Executable Typst helper functions & test harness -│ ├── apply-prefix.typ # SI prefix mathematical helper -│ ├── assert-aeq.typ # Float tolerance assertion library -│ └── unify.typ # Curried unit formatting wrappers -├── listings/ # Code examples and calibration log templates -├── tables/ # Modular specification data tables -├── electrical-specifications.typ -├── mechanical-specifications.typ -├── module-design.typ # Theoretical error budgeting & compensation -├── introduction.typ -├── preamble.typ # Document entry point & main layout -└── LICENSE.md # Comprehensive tri-license legal breakdown -└── LICENSES # Actual licences text -``` +* [`README.md`](README.md): This file +* [`CONTRIBUTING.md`](CONTRIBUTING.md): Contribution guidelines +* [`CODE-OF-CONDUCT.md`](CODE-OF-CONDUCT.md): Contributors code of conduct +* [`LLM-POLICY.md`](LLM-POLICY.md): LLM usage policy on the repo +* [`LICENSE.md`](LICENSE.md): Comprehensive tri-license legal breakdown +* `LICENSES/`: Actual licenses text +* `*.typ`: Core text of the specification, one file per level 1 heading +* `charts/`: Vector charts built with CeTZ-plot +* `diagrams/`: Vector technical drawings & CAS layouts (CeTZ) +* `tables/`: Modular specification data tables +* `lib/`: Executable Typst helper functions & test harness ## Compiling the Specification ### Prerequisites -- [Typst CLI](https://github.com/typst/typst) (v0.15.1 or newer) -- Fonts: standard system serif ans sans-serif fonts +* [Typst CLI](https://github.com/typst/typst) (v0.15.1 or newer) +* Fonts: standard system serif ans sans-serif fonts ### Building the PDF -- cgit