Skip to content

Commit 241b90c

Browse files
authored
Fix broken links that did not cause a yarn build failure (#1636)
Docusaurus did not generate anchors for top-level headings, so they have been changed to second-level ones. This PR fixes a couple of other broken links.
2 parents dc4e88f + b0b8ac7 commit 241b90c

File tree

2 files changed

+8
-9
lines changed

2 files changed

+8
-9
lines changed

docs/website/contents/howtos/contributing/how_to_make_a_release.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ B - the release of FOO-1.0.0 (tag: release-FOO-1.0.0)
297297
A - ...
298298
```
299299

300-
# Installing `scriv`
300+
## Installing `scriv`
301301

302302
To manage the workflow described above, we will use the `scriv` tool slightly
303303
modified to support cabal files. If you use `nix` then you will find `scriv` in
@@ -320,7 +320,7 @@ pass in the flag `--break-system-packages`:
320320
pip install --break-system-packages scriv
321321
```
322322

323-
# Adding a changelog fragment
323+
## Adding a changelog fragment
324324

325325
When a given branch contains a change that deserves a changelog entry, you
326326
should add a changelog
@@ -341,7 +341,7 @@ To create a changelog fragment you can follow these steps:
341341
guidelines][git-contributing-to-a-project].
342342
3. Add the file(s) to the branch.
343343

344-
# Cutting a release
344+
## Cutting a release
345345

346346
First, make sure `scriv` is [installed](#installing-scriv), along with the
347347
following Python3 packages (unless you use `scriv` in a `nix` shell):
@@ -396,7 +396,7 @@ git pull
396396
[contributing-to-a-project]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
397397
[chap]: https://github.com/IntersectMBO/cardano-haskell-packages
398398

399-
# The first time we had to break this release process
399+
## The first time we had to break this release process
400400

401401
On the first half of April 2023, we were asked to get a new Consensus release
402402
from current `master` in order for it to be integrated into the node. However
@@ -459,7 +459,7 @@ a new organization, and also migrate to a new repository.
459459

460460
[solution]: https://github.com/IntersectMBO/cardano-haskell-packages/pull/207
461461

462-
# The new organization
462+
## The new organization
463463

464464
The consensus packages are now split as follows:
465465

docs/website/contents/references/glossary.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<!-- xrefcheck: ignore all -->
21
# Glossary
32

43
Notes on the use and maintenance of this glossary:
@@ -79,7 +78,7 @@ Wraps several other components and provides *chain selection* (ChainSel) functio
7978

8079
This property states that there are at least $k$ blocks in $3k/f$ slots.
8180

82-
Here $f$ refers to the [active slot coefficient](#active-slot-coefficient).
81+
Here $f$ refers to the [active slot coefficient](#active-slot-coefficient-f).
8382

8483
The main Praos theorem also establishes a similarly-shaped bound on the probability of the immutable chain having less than `k` blocks in any contiguous run of `s` slots. The IOG researchers chose `s=3k/f` for Cardano. We started calling it `scg`, since `s` is a pretty common identifier.
8584

@@ -196,7 +195,7 @@ When Ouroboros runs as intended, all short forks are short-lived.
196195
## ;Forecasting
197196

198197
Forecasting is the ability to validate headers that are ahead of a node's current selection.
199-
Because of [Common Prefix](#common-prefix) and [Chain Growth](#chain-growth), the latest `k+1` ledger states along the node's selection always provide sufficient information for the node to validate its peers' headers that are no more than `3k/f` after the peer's first header.
198+
Because of [Common Prefix](#common-prefix) and [Chain Growth](#chain-growth-property), the latest `k+1` ledger states along the node's selection always provide sufficient information for the node to validate its peers' headers that are no more than `3k/f` after the peer's first header.
200199
Since the node hasn't selected that header's block, it has to use forecasting in order to validate its descendant headers.
201200

202201
### ;Forecast horizon
@@ -289,7 +288,7 @@ All honest block-producing nodes that are fully synchronized to the state of the
289288

290289
- active parties - honest caught-up parties plus the adversary.
291290

292-
[Genesis](#genesis) has two natural requirements which must be met throughout the system's lifetime:
291+
[Genesis](miscellaneous/genesis_design.md) has two natural requirements which must be met throughout the system's lifetime:
293292

294293
- The ratio `α` of honest caught-up parties over active parties is above `1/2`.
295294

0 commit comments

Comments
 (0)