Skip to content

hopae-official/architecture-and-reference-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Architecture Reference Framework: The Digital Identity Ecosystem

ARF provides a world-class Architecture Reference Framework for digital identity solutions. Built to global standards, it serves as the foundation for secure, privacy-by-design, interoperable, and scalable digital identity implementations.

Designed to support the full spectrum of digital identity use cases, from credential issuance to verification workflows. As a comprehensive reference architecture, it delivers:

  • Global Standards Compliance - Built on international digital identity standards
  • Production-Ready Architecture - Enterprise-grade scalability and security
  • Interoperability - Seamless integration across different wallet implementations
  • Extensible Framework - Modular design for diverse deployment scenarios
  • Privacy-by-Design - Built-in privacy features

Contributing to Documentation

Local Development

  1. Install dependencies

    pip install -r requirements.txt
  2. Run development server

    mkdocs serve
  3. Edit documentation

    • Documentation files are in the docs/ folder
    • Changes auto-reload in your browser at http://127.0.0.1:8000
  4. Deploy new version

    mike deploy <version> latest // <version> is the version number
    mike serve // you can check it in local env
    mike deploy <version> latest --push // deploy to github pages

Writing Guidelines

  • Use Markdown syntax
  • Add new pages to mkdocs.yml navigation
  • Test locally before submitting PR
  • Follow existing content structure

Deployment

Documentation is automatically deployed to GitHub Pages when changes are merged to main.

Releases

No releases published