Overview

This document defines how the Logos Blockchain team creates, reviews, approves, and maintains technical documentation across its lifecycle.

It covers:

• The purpose and required contents of Requests for Comments (RFCs) and Specifications.
• The maturity stages a document can move through (Raw → Draft → Stable → Deprecated → Retired → Deleted).
• The approval and disapproval criteria at each stage, including required reviewers.
• Versioning rules and responsibilities for updating dependent documents via specification backlinks.

<aside> 💡

We introduced this process to make it easier to track changes and maintain an up-to-date set of specifications. Some specifications were written before introducing this process, so they do not follow these requirements and have been transitioned manually.

</aside>

Documentation Handling Process

Our documentation falls into two main categories: Requests for Comments (RFCs) and Specifications. Other document types—such as Analysis or Overview—are part of our documentation but are not formal specifications.

Request for Comments (RFC)

An RFC is a research-focused document that motivates, introduces, and analyzes a change to an existing specification, or proposes a new one.

An RFC must include:

• A reference to the specification it modifies.
• The goal of the modification, why the specification must change, and the implications of that change.
• A description of the proposed changes.
• An analysis of the implications of implementing those changes.
• Recommended default values, with justification.
• Either:
  • Updated specifications (with changes highlighted, or a full copy of the modified specification), or
  • A new specification that complies with our specification quality standard.

Specification