Skip to content

Commit 6bc56de

Browse files
documentation fixme
1 parent 5209258 commit 6bc56de

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ is very helpful to diagnose build time compiler errors.
8989
Any contributions should be well documented. APIs should have well-written
9090
`haddocks`. If a particular function expects a precondition to be satisfied it
9191
should be explicitly mentioned. The inline documentation is published at
92+
93+
-- TODO link
94+
9295
<https://ouroboros-network.cardano.intersectmbo.org>. When writing haddocks
9396
it's always good to put oneself in the position of somebody who hasn't yet
9497
interacted with your code changes. It's good to explain the key design choices

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Decentralized Message Queue
22

3+
TODO fix these links
4+
35
[![mingw64](https://img.shields.io/github/actions/workflow/status/intersectmbo/ouroboros-network/build.yml?event=merge_group&label=mingw64&style=for-the-badge)](https://github.com/intersectmbo/ouroboros-network/actions/workflows/build.yml)
46
[![Nightly CI](https://img.shields.io/github/actions/workflow/status/intersectmbo/ouroboros-network/nightly.yml?branch=main&label=Nightly&style=for-the-badge)](https://github.com/intersectmbo/ouroboros-network/actions/workflows/nightly.yml)
57

@@ -8,7 +10,7 @@ and consuming messages which are diffused over a P2P network to other nodes.
810

911
This repository provides the `dmq-node` executable to participate in the DMQ network.
1012

11-
todo
13+
TODO diagram
1214
```mermaid
1315
stateDiagram-v2
1416
dn: dmq-node

StyleGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1168,4 +1168,4 @@ There are more general guidelines on how we write and structure code.
11681168
use that shared code in a test suite defined in another package. To avoid
11691169
this problem, we avoid sharing source directories in `cabal` files.
11701170

1171-
[consensus-style-guide]: ../ouroboros-consensus/docs/StyleGuide.md
1171+
[consensus-style-guide]: https://github.com/IntersectMBO/ouroboros-consensus/blob/main/docs/website/contents/howtos/contributing/style_guide.md

0 commit comments

Comments
 (0)