diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 041afe6..85c3c3f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -12,18 +12,38 @@ jobs: name: Build documentation runs-on: ubuntu-latest steps: - - name: Checkout repository - uses: actions/checkout@v4 + - uses: actions/checkout@v4 - - name: Setup Python - uses: actions/setup-python@v5 + - uses: actions/setup-python@v5 with: python-version: '3.12' - - name: Install documentation dependencies + - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install --user -r requirements.txt + pip install -r requirements.txt - name: Build MkDocs site - run: ~/.local/bin/mkdocs build --strict + run: mkdocs build --strict + + deploy: + name: Deploy to GitHub Pages + needs: build + runs-on: ubuntu-latest + if: github.ref == 'refs/heads/main' + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: Deploy to GitHub Pages + run: mkdocs gh-deploy --force diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..8a8c3b7 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,9 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +title: "UltraCore RFT: Deterministic Invariant Systems Research" +authors: + - family-names: "RFT-SIRM" + given-names: "Eugeny" +date-released: 2026-08-01 +url: "https://github.com/RFT-SIRM/UltraCore-RFT" +license: Apache-2.0 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..356e2fd --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,31 @@ +# Code of Conduct + +## Our Pledge + +We pledge to make participation in our community a harassment-free experience +for everyone, regardless of age, body size, disability, ethnicity, gender +identity, level of experience, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +## Our Standards + +Examples of positive behavior: +- Demonstrating empathy and kindness +- Being respectful of differing opinions +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing for mistakes + +Examples of unacceptable behavior: +- Sexualized language or imagery +- Trolling, insulting or derogatory comments +- Public or private harassment +- Publishing others' private information without permission + +## Enforcement + +Instances of abusive behavior may be reported to the project maintainer +via GitHub. All complaints will be reviewed and investigated promptly. + +## Attribution + +Adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3a28822 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to UltraCore RFT + +Thank you for your interest in this project. + +## What this repository is + +UltraCore RFT is a **documentation and research reference repository**. +All executable code lives in the companion implementation repository: + +**→ [RFT-SIRM/Rift-Network](https://github.com/RFT-SIRM/Rift-Network)** + +## How to open an issue + +1. Go to the [Issues tab](https://github.com/RFT-SIRM/UltraCore-RFT/issues). +2. Click **New issue**. +3. Describe the problem clearly: what page, what section, what is incorrect. +4. For implementation issues, open them in [Rift-Network](https://github.com/RFT-SIRM/Rift-Network/issues). + +## How to propose a documentation change + +1. Fork the repository. +2. Create a branch: `git checkout -b fix/your-description`. +3. Edit the relevant Markdown file under `docs/` or `README.md`. +4. Verify locally: `pip install -r requirements.txt && mkdocs build --strict` +5. Open a Pull Request against `main`. + +## What we do not accept + +- Changes to `RFT_MATHEMATICAL_FOUNDATIONS.md` — intentionally stable. +- Code contributions — those belong in Rift-Network. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a53169d --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2026 Eugeny (RFT-SIRM) + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/docs/index.md b/docs/index.md index eb28570..7f9b4b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,21 +1,23 @@ # UltraCore RFT -[![Docs CI](https://github.com/9261834245z-ui/UltraCore-RFT/actions/workflows/docs.yml/badge.svg)](https://github.com/9261834245z-ui/UltraCore-RFT/actions/workflows/docs.yml) +[![Docs CI](https://github.com/RFT-SIRM/UltraCore-RFT/actions/workflows/docs.yml/badge.svg)](https://github.com/RFT-SIRM/UltraCore-RFT/actions/workflows/docs.yml) +[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](../LICENSE) +[![Rift-Network](https://img.shields.io/badge/implementation-Rift--Network-brightgreen)](https://github.com/RFT-SIRM/Rift-Network) -UltraCore RFT is a research reference repository for Reality Fractal Theory (RFT) and the UltraCore Rift architecture. This documentation site is designed to present the project in a structured, modern format with diagrams, architecture flows, and practice-oriented references. +UltraCore RFT is a research reference repository for Reality Fractal Theory (RFT) and the UltraCore Rift architecture. ## Purpose - preserve the technical foundation of the project - support field trial preparation and review -- keep the documentation aligned with the Solana implementation in the external reference repository +- keep the documentation aligned with the Solana implementation - prepare the repository for launch readiness evaluation ## External implementation The production-ready Solana implementation is maintained in the external repository: -https://github.com/RFT-SIRM/Rift-Network +**[https://github.com/RFT-SIRM/Rift-Network](https://github.com/RFT-SIRM/Rift-Network)** ## Navigation @@ -25,7 +27,7 @@ https://github.com/RFT-SIRM/Rift-Network - **Implementation** — integration guidance and external repo summary - **Field Trials** — readiness, launch planning, and review process - **Glossary** — key terms and definitions -- **Research Support** — collaboration guidance and review instructions +- **Research Support** — collaboration guidance ## System overview @@ -36,7 +38,3 @@ flowchart LR C --> D[Rift-Network] D --> E[Field Trials & Validation] ``` - -## Notes - -This repository focuses on documentation and architecture. The external `Rift-Network` repository contains the actual Anchor/Solana implementation and the codebase for production testing. \ No newline at end of file