Skip to content

Commit e3ed1c7

Browse files
authored
Fix stray documentation links (#1656)
2 parents df88019 + 2377694 commit e3ed1c7

File tree

7 files changed

+29
-13
lines changed

7 files changed

+29
-13
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ We have two types of documentation:
2828
When starting to work on Consensus, we recommend to take a look at the following
2929
resources:
3030

31-
- [Preflight guide](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/PreflightGuide/)
32-
- [Glossary](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary/)
31+
- [Preflight guide](https://ouroboros-consensus.cardano.intersectmbo.org/docs/tutorials/preflight_guide/)
32+
- [Glossary](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/glossary/)
3333

3434
When adding or improving documentation about the implementation, it is
3535
preferable to add haddock comments since they are closer to the code. However
@@ -336,7 +336,7 @@ package, we should release it to CHaP instead (see the
336336
[CHaP README](https://github.com/IntersectMBO/cardano-haskell-packages)
337337
for more).
338338

339-
In general, we strive to avoid having `source-repository-package`s on our `main` branch. However, there are situations where we want to prevent pull requests from piling up while awaiting the release of upstream components[^1].
339+
In general, we strive to avoid having `source-repository-package`s on our `main` branch. However, there are situations where we want to prevent pull requests from piling up while awaiting the release of upstream components[^1].
340340
In these cases, we allow merging pull requests that contain `source-repository-package`s, provided the referenced commit is on the `main` branch of the upstream package.
341341

342342
If you do add a temporary `source-repository-package` stanza, you need to

docs/website/contents/references/miscellaneous/chain_sync.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Note on terminology:
2323
2. From (1), the intersection between their chain and our chain must be within
2424
`k` blocks from our tip.
2525
3. Since our fragment will be anchored `k` back, from (2) we get that the
26-
intersection between their chain and our chain must lie on our fragment.
26+
intersection between their chain and our chain must lie on our fragment.
2727
(NOTE: In the case of corruption of volatile DB -- or being near genesis --
2828
our fragment may be shorter than `k`, but even in that case, the length of
2929
our fragment will dictate our maximum rollback.)
@@ -37,7 +37,7 @@ Note on terminology:
3737
fragment, which would mean that we would miss some blocks.
3838

3939
Note that if both nodes are following the same chain and are up to date, the
40-
intersection will be the _tip_ of both fragments.
40+
intersection will be the _tip_ of both fragments.
4141

4242
## Chain evolution
4343

@@ -73,7 +73,7 @@ The scenario is something like this:
7373

7474
```
7575
k
76-
/~~~~~~~~~~\
76+
/~~~~~~~~~~\
7777
7878
..................\........------------ our fragment
7979
\
@@ -115,7 +115,7 @@ We get notified through the chain sync protocol about updates to their chain:
115115
our chain, so the new intersection point must /be/ the rollback point.
116116
If that rollback point lies on our fragment (and hence is within @k@),
117117
all is good; otherwise, we disconnect.
118-
118+
119119
Notes:
120120
- We could additionally (and optionally) check that they do not roll
121121
back more than `k`, and if they do, treat them as adversarial (disconnect).
@@ -158,4 +158,4 @@ trim their fragment so that it is anchored at our anchor point.
158158
sufficient number of headers to determine if their chain is preferred over
159159
ours (this needs careful consideration when adopting genesis).
160160

161-
[^glossary]: See the [Glossary](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary/)
161+
[^glossary]: See the [Glossary](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/glossary/)

docs/website/contents/tutorials/preflight_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ for Ungrindable Blockchains" by Kiayias et al](https://eprint.iacr.org/2021/1698
303303
[Magic Wormhole]: https://github.com/magic-wormhole/magic-wormhole
304304
[db-analyser]: https://github.com/IntersectMBO/ouroboros-consensus/blob/main/ouroboros-consensus-cardano/README.md#db-analyser
305305
[Cardano ledger]: https://github.com/IntersectMBO/cardano-ledger
306-
[Glossary]: https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary/
306+
[Glossary]: https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/glossary/
307307
[db-analyser snapshot]: https://github.com/IntersectMBO/ouroboros-consensus/blob/main/ouroboros-consensus-cardano/README.md#saving-a-snapshot
308308
[preflight epic]: https://github.com/IntersectMBO/ouroboros-consensus/issues/887
309309
[Ouroboros Praos paper]: https://iohk.io/en/research/library/papers/ouroboros-praos-an-adaptively-secure-semi-synchronous-proof-of-stake-protocol/

docs/website/docusaurus.config.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,22 @@ const config = {
194194
from: '/docs/for-developers/utxo-hd/overview',
195195
to: '/docs/references/miscellaneous/utxo-hd/',
196196
},
197+
{
198+
from: '/docs/for-developers/utxo-hd/Overview/',
199+
to: '/docs/references/miscellaneous/utxo-hd/',
200+
},
201+
{
202+
from: '/docs/for-developers/PreflightGuide/',
203+
to: '/docs/tutorials/preflight_guide/',
204+
},
205+
{
206+
from: '/docs/for-developers/Glossary/',
207+
to: '/docs/references/glossary/',
208+
},
209+
{
210+
from: '/docs/for-developers/BootstrapPeersIER/',
211+
to: '/docs/references/miscellaneous/bootstrap_peers_IER/',
212+
},
197213
],
198214
createRedirects(existingPath) {
199215
if (existingPath.includes('/docs/references/miscellaneous/utxo-hd')) {

ouroboros-consensus-cardano/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
### Breaking
3939

4040
- Implement the UTxO-HD feature. See the documentation in [the
41-
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/Overview/).
41+
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/miscellaneous/utxo-hd/).
4242
Fill in the UTxO-HD type families and instances for Shelley based blocks, the
4343
Byron block and the Cardano block.
4444

ouroboros-consensus-diffusion/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
### Breaking
3131

3232
- Implement the UTxO-HD feature. See the documentation in [the
33-
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/Overview/).
33+
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/miscellaneous/utxo-hd/).
3434
- `hStateQueryServer` now needs a `ResourceRegistry` to allocate `Forker`s.
3535
- `DiskPolicyArgs` was transformed into `SnapshotPolicyArgs`.
3636
- `StdRunNodeArgs` got two new fields:
@@ -254,7 +254,7 @@ NOTE: version jumps from `0.11.0.0` to `0.13.0.0` because `0.12.0.0` was created
254254

255255
- Added the Genesis State Machine (GSM), though for now it is merely the
256256
simpler [Bootstrap Peers State
257-
Machine](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/BootstrapPeersIER/).
257+
Machine](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/miscellaneous/bootstrap_peers_IER/).
258258

259259
- Added `rnGetUseBootstrapPeers` to `RunNodeArgs`, for dynamically
260260
enabling/disabling the GSM. The proper GSM must always be running, despite

ouroboros-consensus/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
### Breaking
6363

6464
- Implement the UTxO-HD feature. See the documentation in [the
65-
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/Overview/).
65+
webpage](https://ouroboros-consensus.cardano.intersectmbo.org/docs/references/miscellaneous/utxo-hd/).
6666
- The `LedgerState` type family changed its kind to `Type -> (Type -> Type) ->
6767
Type` to account for `MapKind`s.
6868
- `LedgerTables` store a `MapKind` of `TxIn l` to `TxOut l`.

0 commit comments

Comments
 (0)