About

This site is the engineering documentation for the PeerPay blockchain platform. It is written and maintained by the PeerPay engineering team and is intended for:

  • Backend, frontend and DevOps engineers working on PeerPay services.
  • Enterprise partners who deploy a remote peer or secondary orderer against the PeerPay network.
  • Reviewers and auditors who need a clear architectural picture of the system.

What This Documentation Covers

  • A high-level Architecture Overview of how the PeerPay repositories fit together.
  • A detailed page per component under Architecture Components in the navigation.
  • A DevOps Guide covering local setup, container management, logging, CI/CD, and rollback.

Building This Site Locally

The site is built with MkDocs using the readthedocs theme and the mkdocs-mermaid2-plugin for diagram rendering.

# From the repository root
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

# Live-reload server on http://localhost:8000
mkdocs serve

# One-shot build into ./site
mkdocs build

Repository Layout

peerpay-docs-blockchain-tree/
├── docs/
│   ├── index.md                # Overview + topology diagram
│   ├── about.md                # This page
│   ├── devops-guide.md         # Operations / DevOps reference
│   ├── components/             # One page per repository
│   └── img/                    # Static assets (logos, icons)
├── mkdocs.yml                  # MkDocs configuration
└── requirements.txt            # Python dependencies for the build

Contributing

  1. Create a feature branch from main.
  2. Edit or add Markdown files under docs/.
  3. Run mkdocs serve and review the rendered output locally.
  4. Open a pull request describing the documentation change.

When adding a new component, please also:

  • Add a navigation entry in mkdocs.yml.
  • Cross-link to the new page from index.md (the topology diagram and the Repository Roles section).

Conventions

  • Use fenced code blocks (```bash, ```yaml, etc.) so syntax highlighting is applied.
  • Use mermaid fenced blocks for diagrams.
  • Reference repositories and chaincodes by their exact name in backticks (e.g. peerpay-fabric, bankloan).
  • Prefer relative links between docs pages (e.g. components/peerpay-fabric.md) so navigation works in both mkdocs serve and the published site.