Skip to content

Latest commit

 

History

86 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WikiStub-Seed

WikiStub-Seed

EN | DE | ES | JA | RU | ZH

WikiStub-Seed is a multilingual JSON knowledge framework for AI-assisted research, documentation, learning systems and LLM workflows. It ships 630 compact knowledge stubs across 12 scientific and cultural domains. Definitions are populated in DE/EN/ES/ZH/JA/RU; relevance notes are populated in DE/ES/ZH/JA/RU and use the documented German fallback for the currently empty English relevance slots.

WikiStub-Seed is a knowledge-stub seed library, not a wiki.

WikiStub-Seed test gates Version Ecosystem: dev-bricks Umbrella: open-bricks Stubs Languages Format Python Platform Privacy Security Security SLA Code Style: Ruff Third-Party Licenses Marketing Log Tests llms.txt License

Quick Navigation


1. Executive Summary

If you want to... Open this
Inspect the dataset wikistub_seed.json
Run a quick local check python wikistub_seed_cli.py check
Export Markdown for docs or notes python wikistub_seed_pipeline.py export --output --english
Understand the exchange format EXPORTFORMAT.md
Read the optional local search contract EMBEDDING_SEARCH_API.md
Browse the static PWA source web_publisher/
Read AI/LLM index file llms.txt
Read the German guide README_de.md

Note

AI & LLM Integration: For machine-readable context, repository structure, search phrases, and LLM guidelines, see llms.txt.

Key Features

  • 630 Knowledge Stubs: Curated in wikistub_seed.json with definitions across 6 languages (DE, EN, ES, ZH, JA, RU) and relevance notes across 5 languages.
  • 12 Top-Level Domains: Mathematics, physics, chemistry, biology, medicine, psychology, AI/CS, engineering, society, economics, history, and culture.
  • 85 Structured Subcategories: Short, neutral definitions and practical relevance notes.
  • Zero Third-Party Runtime Dependencies: Core import, export, validation, CLI, and edit server run on the standard Python 3.10+ library.
  • Dual Consumption Models: Batch CLI export to structured Markdown or static PWA reader with offline ServiceWorker search.

Use Cases

  • Seed a local knowledge base for AI-assisted writing or research.
  • Build documentation glossaries, learning maps or concept catalogs.
  • Export structured Markdown for Obsidian, GitHub Pages or static documentation sites.
  • Feed retrieval, embeddings or LLM context pipelines with compact domain stubs.
  • Translate and extend a domain-neutral knowledge skeleton in a controlled JSON format.

2. System Architecture & Data Flow

flowchart TD
    A["wikistub_seed.json<br/>(630 Multilingual Stubs)"] --> B["wikistub_seed_cli.py<br/>(Stats & Validation)"]
    A --> C["wikistub_seed_pipeline.py<br/>(Markdown & JSON Exporter)"]
    A --> D["web_publisher/_build.py<br/>(Static PWA Publisher)"]
    A --> E["RAG & LLM Context Pipelines<br/>(AI Workflows & Embeddings)"]
    C --> F["Structured Markdown<br/>(Obsidian / GitHub Pages / Docs)"]
    D --> G["PWA Web Frontend<br/>(Offline Search / 6 Languages)"]
Loading

3. Zero-Egress Lifecycle & Query Flow

sequenceDiagram
    autonumber
    actor User as Developer / AI Agent
    participant CLI as wikistub_seed_cli / pipeline
    participant Data as wikistub_seed.json (630 Stubs)
    participant Builder as web_publisher/_build.py
    participant PWA as Static PWA / ServiceWorker
    
    User->>CLI: Run check / stats / validate
    CLI->>Data: Validate 12 Domains, 85 Subcategories & Maps
    Data-->>CLI: 630 Stubs Validated (Zero Egress / 100% Local)
    CLI-->>User: Console Report & Consistency Proof
    
    opt Export Markdown / RAG Context
        User->>CLI: export --output --english
        CLI->>Data: Read definitions & relevance maps
        CLI-->>User: Write structured Markdown to output/
    end
    
    opt Build & Serve Local PWA
        User->>Builder: Run _build.py
        Builder->>Data: Slices & indexes stubs
        Builder-->>PWA: Generates data/wikistub_seed.json & search-index.json
        PWA-->>User: Offline instant search in 6 languages
    end
Loading

4. Safety Model & Governance Invariants

The following 10 invariants govern all WikiStub-Seed components, pipelines, and tools:

# Invariant Guarantee Enforcement Mechanism
1 100% Local-First & Zero-Egress (INV-LOCAL-01) Core datasets, CLI operations, and exports execute completely offline with zero telemetry. Python standard library only; no unsolicited network calls during import, export, or check.
2 Non-Elevation (RunAsInvoker / INV-SEC-02) System never requires or requests root or administrator privileges. Operates in unprivileged user space; file and loopback operations run as invoker.
3 Deterministic Knowledge Schema (INV-SCHEMA-03) 630 stubs strictly validated across 12 domains and 85 subcategories. Automated schema validation (wikistub_seed_pipeline.py validate) and duplicate checkers.
4 Pure Offline Storage & Zero Telemetry (INV-STORE-04) No tracking, telemetry, user data transmission, or external logging. Local JSON (wikistub_seed.json) and Markdown output files only.
5 Localhost-Bound Edit Server (127.0.0.1 / INV-SRV-05) Optional HTTP GUI server binds strictly to the loopback interface. Hardcoded 127.0.0.1 binding, DNS rebinding rejection, strict Content-Type: application/json CSRF defense.
6 PBKDF2 Password Hashing & Soft-Delete Trash (INV-AUTH-06) Passwords stored with cryptographic salt/hash; accidental deletes recoverable. hashlib.pbkdf2_hmac in wiki_auth.json and soft-delete in wikistub_seed_trash.json (both gitignored).
7 Cross-Platform Operating Parity (INV-PLAT-07) Identical behavior across Windows, Linux and macOS environments. Multi-OS GitHub Actions CI matrix and dual runner smoke validation.
8 Pure Python Standard Library Core (INV-CORE-08) Zero required third-party dependencies for runtime operations. Built entirely on Python stdlib (json, pathlib, http.server, hashlib, argparse).
9 Cloud-Sync Conflict Defense (INV-SYNC-09) Protection against multi-device synchronization collisions. .gitignore filters *.sync-conflict-*, *.conflict, LOCK.*.
10 48h Security SLA & Coordinated Disclosure (INV-SLA-10) Responsible reporting with guaranteed acknowledgment SLA. Documented SECURITY.md SLA, private vulnerability reporting & multi-channel contact emails.

5. Installation & Quick Start

git clone https://github.com/dev-bricks/WikiStub-Seed.git
cd WikiStub-Seed

python wikistub_seed_cli.py --help
python wikistub_seed_cli.py stats
python wikistub_seed_cli.py check
python wikistub_seed_pipeline.py validate
python wikistub_seed_pipeline.py export --output --english

On Windows, start.bat opens the CLI entry point. Exported files are written to output/; that folder is local and not versioned.


6. Local Edit Mode & HTTP Server

web_publisher/ is a static site (no server, fetch()-only) and cannot write. edit_server.py adds a small, 127.0.0.1-only HTTP server on top of it so the same reader UI can create, edit and delete articles/categories:

python edit_server.py            # default port 8879, opens the browser

Rights model (verbatim from the specifying request, and the one binding rule this feature follows):

  • Creating new entries is allowed by default, for everyone.
  • Editing and deleting are allowed for everyone as long as no password is set.
  • Once a password is set, whoever set it decides what an anonymous visitor may still do — anywhere from "everything" down to read-only (create/edit/delete are independently revocable via the "Konto" panel in the header).
  • There is deliberately only one password/role. Multiple tokens with different rights plus an administrator role were considered "maybe a bit much" and are documented as a Roadmap idea below, not built.

Security notes:

  • The server only ever binds to 127.0.0.1 — this is not configurable; there is no network/cloud exposure by design.
  • The password is stored as a PBKDF2-HMAC-SHA256 hash (wiki_auth.json, gitignored), never in plaintext. This hash defends against a casual read of the file revealing a reused password — it does not defend against local filesystem access; anyone who can already read/write files on the machine can replace wiki_auth.json outright. Forgotten password? Delete wiki_auth.json to return to the default (no password, full rights for everyone).
  • Every mutating request must carry Content-Type: application/json (rejects classic <form>-based CSRF, which cannot send that content type without a CORS preflight this server does not answer) and a Host header of localhost/127.0.0.1 (rejects DNS rebinding).
  • Deletions are soft: articles and categories move to wikistub_seed_trash.json (gitignored) instead of being removed outright, and can be restored via the API.
  • web_publisher/data/wikistub_seed.json and search-index.json are tracked, committed build artifacts. Every successful edit-mode write rebuilds them from the same _build.py this repository's CI already runs. If you used the local edit server to try something out, git status before committing — a local test edit dirties these two files exactly like a real one would, and nothing here git-ignores them for you (they need to stay tracked for GitHub Pages hosting without a build step).

7. Core Commands & CLI Operations

Command Purpose
python wikistub_seed_cli.py stats Print stub, category and tag statistics
python wikistub_seed_cli.py check Run consistency checks over the JSON dataset
python wikistub_seed_pipeline.py validate Validate the pipeline input data
python wikistub_seed_pipeline.py export --output --english Export the JSON dataset to Markdown
python wikistub_seed_pipeline.py translate Optionally translate missing English definitions when configured

8. Repository Map & Key Files

Path Purpose
wikistub_seed.json Authoritative multilingual knowledge dataset
01_Mathematik/ ... 12_Kultur_Kunst_Sprache/ Domain-oriented Markdown source/export structure
wikistub_seed_cli.py CLI for stats and checks
wikistub_seed_pipeline.py Import, export, validation and optional translation pipeline
md_to_json.py Markdown-to-JSON import helper
check_duplicates.py Duplicate/consistency helper
EXPORTFORMAT.md Stable exchange-format plan
web_publisher/ Static Web/PWA publisher (offline cache, search, six-language selector)
edit_server.py Local-only (127.0.0.1) HTTP server adding GUI create/edit/delete to web_publisher/
wiki_store.py Pure CRUD + soft-delete/trash functions the edit server uses
wiki_auth.py Password hashing, permission model and session tracking for the edit server

9. Data Shape & Knowledge Schema

Each stub is intentionally small, machine-readable, and deterministic:

{
  "title": "Domain-Driven Design",
  "definition_de": "Ein Ansatz zur Modellierung komplexer Software, der die Fachdomäne in den Mittelpunkt stellt.",
  "definition_en": "An approach to modeling complex software that places the business domain at the center of development.",
  "relevance": "Hilft, komplexe Systeme verständlich und wartbar zu gestalten.",
  "definitions": {
    "de": "Ein Ansatz zur Modellierung komplexer Software, der die Fachdomäne in den Mittelpunkt stellt.",
    "en": "An approach to modeling complex software that places the business domain at the center of development.",
    "es": "Un enfoque para modelar software complejo que sitúa el dominio de especialidad en el centro.",
    "zh": "一种对复杂软件进行建模的方法,它将专业领域置于中心位置。",
    "ja": "専門領域をその中心に据える、複雑なソフトウェアをモデリングするためのアプローチ。",
    "ru": "Подход к моделированию сложного программного обеспечения, который ставит предметную область в центр внимания."
  },
  "relevance_i18n": {
    "de": "Hilft, komplexe Systeme verständlich und wartbar zu gestalten.",
    "en": "",
    "es": "Ayuda a que los sistemas complejos sean comprensibles y mantenibles.",
    "zh": "有助于使复杂系统更易于理解和维护。",
    "ja": "複雑なシステムを理解しやすく、保守しやすく構築するのに役立ちます。",
    "ru": "Помогает сделать сложные системы понятными и простыми в сопровождении."
  },
  "tags": ["Informatik", "Software Engineering"]
}

The current authoritative source is wikistub_seed.json. EXPORTFORMAT.md documents the stable wrapper format wikistub-seed-data-v1 for Web/PWA, API and LLM exports.


Bundles and partners

Generated discovery projection for module:WikiStub-Seed from catalog:v4-bundles (546290dafbaafd810df1d59ef5a3d7183738472b48cd5a8a81f1e8f2b64d852e). Target repository visibility: public. Bundle manifests remain the membership authority; this section does not install or activate components. Discovery approval: public module-registry record, explicit default-deny bundle allowlist.

ellmos-knowledge-bundle

  • Bundle recipe visibility: private; role: declared-component; requirement: recommended.
  • module partners: module:KnowledgeDigest, module:project-docs-template, module:report-forge, module:web-scraper.
  • skill partners: skill:bilingual-doc-sync, skill:docs-analysis, skill:document-chunker.

Composition and runtime details are intentionally omitted.

10. Sibling Tools & Ecosystem Matrix

WikiStub-Seed is part of the dev-bricks developer suite and the wider open-bricks ecosystem:

Tool Organization Purpose Status
dev-bricks/DevCenter dev-bricks Unified developer dashboard, repo health overview & project launcher Production
dev-bricks/CodeBox dev-bricks Lightweight PySide6 desktop IDE with syntax highlighting & terminal Beta
dev-bricks/MethodenAnalyser dev-bricks AST-based Python code analysis, import optimizer & dead-code detection Production
dev-bricks/CareCenter-for-Codex dev-bricks Workspace health check, diagnostics & test orchestration Production
dev-bricks/safe-start-for-codex dev-bricks Safe initialization and verification for development workspaces Production
dev-bricks/automation-master dev-bricks Automated release management and workflow orchestration Production
dev-bricks/automizer-for-claude-desktop dev-bricks Claude Desktop scheduled task and workflow automation utility Production
ellmos-ai/project-docs-template ellmos-ai Standardized documentation generator and compliance framework Production
ellmos-ai/policy-registry ellmos-ai Declarative governance and machine-readable policy enforcement engine Production
ellmos-ai/sqlite-transit-sync ellmos-ai Zero-egress local SQLite synchronization and replication engine Production
doc-bricks/PDFtoPDFocr doc-bricks Offline OCR PDF processor with zero external telemetry Production
doc-bricks/MediaBrain doc-bricks Local multimedia indexer, transcriber & offline metadata vault Production
doc-bricks/DokuReader doc-bricks Document reader and semantic exploration desktop environment Production
doc-bricks/CleanMarkdown doc-bricks Markdown formatting, linting and structure standardization tool Production
file-bricks/WinStorePackager file-bricks Automated MSIX packager for Python & PySide6 desktop apps Production
file-bricks/NoteSpaceLLM file-bricks Note management and semantic retrieval system for desktop Production
open-bricks/open-bricks open-bricks Umbrella repository for all open-source bricks components Production

11. Discovery & Search Keywords

Use the canonical repository name dev-bricks/WikiStub-Seed when linking or searching. The project was formerly connected to file-bricks/MetaWiki, but the current repo is the dev-bricks knowledge-stub seed library.

Search phrases that describe this project well:

  • WikiStub-Seed JSON knowledge stubs
  • bilingual JSON knowledge base Python
  • local-first ontology seed library for LLM workflows
  • multilingual knowledge stubs framework
  • RAG knowledge base German English JSON
  • static PWA knowledge publisher offline
  • domain knowledge ontology open source Python

12. Security & Vulnerability Reporting

WikiStub-Seed adheres to strict local-first and zero-egress invariants. For detailed vulnerability reporting guidelines, SLAs, and PGP keys, consult SECURITY.md.

  • Initial Response SLA: 48 hours
  • Triage SLA: 5 business days
  • Private Reporting: GitHub Security Advisories
  • Direct Contacts: security@open-bricks.org, security@ellmos.ai, support@lukasgeiger.com, lukas@open-bricks.org

13. Third-Party Licenses & Transparency

WikiStub-Seed is committed to 100% permissive licensing, zero-egress architecture, and complete dependency transparency. The core runtime requires zero external dependencies and operates purely on the Python standard library.

For the comprehensive inventory of runtime, optional translation, build, and QA tooling dependencies, alongside their full license texts and verified runtime invariants (INV-LOCAL-01 to INV-SLA-10), see THIRD_PARTY_LICENSES.md.

All source code is released under the MIT License. This project is an unpaid open-source donation. Liability is limited to intent and gross negligence under Section 521 of the German Civil Code (BGB), with the MIT License disclaimers applying as well.


14. Marketing & Target Personas

WikiStub-Seed delivers high-signal, domain-curated knowledge stubs for AI context injection, RAG architectures, and offline documentation. Detailed persona breakdowns (AI/LLM engineers, knowledge curators, local-first developers, educators), high-intent discovery search queries, competitive matrix (vs. Wikipedia dumps/Kiwix, MediaWiki, Common Crawl, Docusaurus), and the strategic adoption roadmap are documented in MARKETING-LOG.txt.


15. German Documentation / Deutsche Version

Eine vollständige deutsche Dokumentation inklusive 15-Punkte-Schnellnavigation, Systemarchitektur, Governance-Tabelle und Drittanbieter-Transparenz steht unter README_de.md zur Verfügung.

Releases

Packages

Used by

Contributors

Languages