How dpgalliance/dpg-standard works
Project type and purpose
• This is an open-source documentation/standards project (“Digital Public Goods Standard”) housed in a Git repository. It provides a set of guidelines, markdown files, governance documents, and review processes to define and maintain an open standard.
• Its purpose is to publish and evolve the DPG Standard, maintain supporting docs (standard.md, governance.md, expert-groups.md, etc.), and operationalize the standard via an external questionnaire and registry.
File structure
• Top-level folders/files:
• .github/workflows/main.yml — CI pipeline configuration
• docs/ — supporting markdown templates and process docs (e.g., pull_request_template.md, standard-questions.md)
• standard.md, governance.md, expert-groups.md, openstand.md — core content of the standard and governance
• README.md, CHANGELOG.md, LICENSE, CODE_OF_CONDUCT.md — project metadata and policies
• No application code or backend/frontend code: this is a content-centric repo.
• CI pipeline likely runs markdown linting, link checking, possibly site generation or deployment (e.g., to GitHub Pages or a docs site).
README for additional insights
• Mentions external systems: the online questionnaire (app.digitalpublicgoods.net/form) and the public registry (digitalpublicgoods.net/registry).
• Emphasizes governance, code of conduct, contribution process.
a. Main components
• GitHub Repository (content store)
• GitHub Actions CI/CD pipeline
• Documentation hosting (e.g., GitHub Pages or an SSG pipeline)
• Contributors & Maintainers (Users)
• External questionnaire service (Digital Public Goods Form)
• Public Registry (Registry website)
• Review workflow actors: L1 Reviewers, L2 Reviewers, Expert Reviewers
b. Relationships and interactions
• Contributors push branches and open Pull Requests → triggers GitHub Actions
• CI checks the markdown, lint, link validation → notifies contributors
• PR moves through governance flow: L1 → L2 → Expert Reviewer → decision → merge or request changes
• On merge to main, CI triggers site build/deploy → publishes updated docs
• Public users view docs on the hosted site or GitHub Pages
• Project references external questionnaire service and registry via hyperlinks
c. Architectural patterns and design principles
• Git-based version control with feature branches and pull-request review
• CI/CD for automated validation and publishing
• Separation of concerns: content (markdown) versus process (governance, workflows)
• Extensibility via markdown templates and a modular docs folder
d. Key technologies and frameworks
• GitHub (repo hosting, Issues, PRs)
• GitHub Actions for CI/CD
• Markdown as content format
• Creative Commons license (CC BY-SA 4.0)
• External services: Digital Public Goods Alliance registry and questionnaire app