How orcwg/cra-hub works
Project type and purpose
• This repository (“CRA Hub”) is a documentation hub: a statically-served collection of Markdown files (FAQs, inventories, product definitions, questionnaires, standards, resources).
• It is intended to provide everything a user needs to know about the Cyber Resilience Act (CRA) and its implementation—no dynamic backend or database, purely content.
File structure
• Top-level Markdown files (LICENSE.md, README.md, faq.md, inventory.md, standards.md) form the main navigation.
• Four subdirectories hold related content:
• product-definitions/ – Excel and PDF inputs plus explanation Markdown
• questionnaires/ – Markdown questionnaires for manufacturers and OSS projects
• resources/ – PDFs and templates, with a README overview
• community-resources.md & other top-level docs
• No code directories (src/, lib/) or server-side scripts—this is a static content repository.
• Absence of CI config (e.g., GitHub Actions) suggests content is rendered by GitHub Pages (Jekyll) by default.
README for additional insights
• README clearly lays out site sections and external links (Google spreadsheets, pull-requests, issues, EU Commission PDFs).
a. Main components
• Content Repository (GitHub repo with Markdown + assets)
• Static Site Generator (Jekyll on GitHub Pages or similar)
• Hosting Platform (GitHub Pages CDN)
• Client Browser (end user viewing the site)
• Developer Workflow Tools (Git, GitHub UI, issues, PRs)
• External Resources (Google Sheets, EU Commission PDFs, Issue trackers)
b. Relationships & interactions
• Developer pushes commits to the GitHub repo → triggers site rebuild.
• Static Site Generator compiles Markdown → outputs HTML/CSS/JS.
• Hosting Platform serves static site assets from CDN to Client Browser.
• Client Browser may fetch embedded/external resources (Google Sheets links, PDF assets in /resources).
• Developer and community members interact via GitHub Issues and Pull Requests.
c. Architectural patterns and principles
• Content-as-code: treat documentation as code, versioned in Git.
• Static Site Hosting: no runtime backend, all pages pre-rendered for speed and security.
• Distributed collaboration using pull requests, issues for content updates.
d. Key technologies
• Markdown (content format)
• Git & GitHub (version control, collaboration)
• Jekyll (or other SSG) for build – implicit via GitHub Pages
• GitHub Pages (hosting/CDN)
• External embeddable links (Google Sheets, PDFs)