Update the roadmap
The network upgrades page shows the hard forks being built and every hard fork so far. An upcoming hard fork comes from one entry in src/data/roadmap.js, an enacted one from src/data/hardforks.js. The changes of an enacted hard fork are in getCompletedChanges() in src/data/roadmap.js. The page makes no network request, so it changes only through a pull request. This page explains the fields and the rules.
Rules
- The hard fork plan, the working group minutes, and the readiness page are the source. The hard fork plan gives the scope, the protocol version, and the code completion target. The hard fork working group minutes report each step a hard fork reaches. The readiness page of a hard fork, for example the Dijkstra readiness page, tracks its hard fork action on Preview, Preprod, and the Cardano mainnet. The text only says what they confirm.
- Every entry links to the section that backs it. A change links to its CIP, or to its section of the plan where it has no CIP. Where the working group has settled a change differently from the plan, link the impact analysis of the change in the Dijkstra upgrade overview instead. A note links to the plan and to the minutes it relies on.
- Facts, not promotion. Say what a change does, in one or two sentences. A figure goes in only if the linked page states it.
- Nothing dated in the text. The code completion target from the plan is the only date. Change it when the plan changes it.
- Proper names stay in English. A name such as "Ouroboros Peras" is a plain string. Wrap every other string in
translate()so it reaches Crowdin.
Fields of a hard fork
Entries of getHardForks(), next one first.
| Field | Required | Description |
|---|---|---|
key | yes | Stable identifier, kebab-case. Also the anchor: /roadmap#<key> opens the entry. |
name | yes | For example "Dijkstra, phase 1", through translate(). |
era | yes | The ledger era the hard fork belongs to. Labels its band on the line of protocol versions. |
version | yes | The protocol major version the hard fork moves the Cardano mainnet to, or null while the plan gives none. With a version, the hard fork appears on the line of protocol versions. |
stage | yes | How far along it is, see below. The path and the progress segments are drawn from it. |
note | yes | One or two sentences under the path: the code completion target, and what the minutes report. Links are written [text]({name}), with the addresses passed as values. |
changes | yes | What the hard fork brings, in the order of the hard fork plan. See the fields below. |
Stages
stage | Set it when |
|---|---|
development | The hard fork is in the plan and cannot be tested on a network yet. |
devnet | The minutes report that its changes can be tested on the developer testnet. |
preview | The hard fork is enacted on the Preview testnet. |
preprod | The hard fork is enacted on the Preprod testnet. |
vote | The hard fork initiation action is submitted on the Cardano mainnet. |
mainnet | The action is ratified and waits for the epoch boundary where it takes effect. |
Fields of a change
Entries of a hard fork's changes, and of a list in getCompletedChanges(). Each entry is one cell on the page.
| Field | Required | Description |
|---|---|---|
key | yes | Stable identifier, kebab-case. |
name | yes | Name of the change, as the plan or the CIP calls it. Proper names are plain strings, descriptive names go through translate(). |
text | yes | One or two sentences on what changes, written from the plan or from the abstract of the CIP. |
source | yes | cip(number) where a CIP exists, hardForkPlan(section) where it does not. For an enacted hard fork without a plan, a link to the public page that states the change. |
Updating a hard fork
When a hard fork reaches its next step, set its stage and update its note. The readiness page shows whether the hard fork action on Preview, Preprod, or the Cardano mainnet has gone through. The address of the minutes is WORKING_GROUP_MINUTES_URL at the top of the file. When the plan changes the scope, the target, or the protocol version, change those fields. Mention the source in the pull request.
Adding a hard fork
- Add an entry to
getHardForks()insrc/data/roadmap.js, following the fields above. Usetranslate()with ids prefixedroadmap.fork.<key>.for the hard fork androadmap.change.<key>.for a change. - Run
yarn write-translations --overrideand keep only the new keys ini18n/en/code.json. - Run
yarn lint,yarn test, andyarn build, then check/roadmap/in light and dark mode, and open the entry. - Open a pull request with the source you used in the description.
When a hard fork is enacted
- Move its
changesfrom its entry ingetHardForks()togetCompletedChanges()in the same file, under its protocol version. Then remove the entry fromgetHardForks(). - Add an entry at the top of
getHardForkHistory()insrc/data/hardforks.jswith the era, the date, the name, a one-sentence description, the epoch, the protocol version, and the transaction ID of the governance action. Its anchor on the page is/roadmap#protocol-version-<number>. - Add or update the glossary entry of the hard fork in
glossary/.