Skip to content

Commit 4b9f49d

Browse files
committed
doc: fix broken relative md links
These relative links in our documentation are broken, fix them.
1 parent 9d1a286 commit 4b9f49d

File tree

5 files changed

+15
-16
lines changed

5 files changed

+15
-16
lines changed

doc/design/libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class bitcoin-qt,bitcoind,bitcoin-cli,bitcoin-wallet bold
9595

9696
- The only thing that should depend on *libbitcoin_kernel* internally should be *libbitcoin_node*. GUI and wallet libraries *libbitcoinqt* and *libbitcoin_wallet* in particular should not depend on *libbitcoin_kernel* and the unneeded functionality it would pull in, like block validation. To the extent that GUI and wallet code need scripting and signing functionality, they should be get able it from *libbitcoin_consensus*, *libbitcoin_common*, and *libbitcoin_util*, instead of *libbitcoin_kernel*.
9797

98-
- GUI, node, and wallet code internal implementations should all be independent of each other, and the *libbitcoinqt*, *libbitcoin_node*, *libbitcoin_wallet* libraries should never reference each other's symbols. They should only call each other through [`src/interfaces/`](`../../src/interfaces/`) abstract interfaces.
98+
- GUI, node, and wallet code internal implementations should all be independent of each other, and the *libbitcoinqt*, *libbitcoin_node*, *libbitcoin_wallet* libraries should never reference each other's symbols. They should only call each other through [`src/interfaces/`](../../src/interfaces/) abstract interfaces.
9999

100100
## Work in progress
101101

doc/design/multiprocess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ In the current design, class names, method names, and parameter names are duplic
142142

143143
An alternate approach could use custom [C++ Attributes](https://en.cppreference.com/w/cpp/language/attributes) embedded in interface declarations to automatically generate `.capnp` files from C++ headers. This has not been pursued because parsing C++ headers is more complicated than parsing Cap’n Proto interface definitions, especially portably on multiple platforms.
144144

145-
In the meantime, the developer guide [Internal interface guidelines](developer-notes.md#internal-interface-guidelines) can provide guidance on keeping interfaces consistent and functional and avoiding compile errors.
145+
In the meantime, the developer guide [Internal interface guidelines](../developer-notes.md#internal-interface-guidelines) can provide guidance on keeping interfaces consistent and functional and avoiding compile errors.
146146

147147
### Interface Stability
148148

doc/developer-notes.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ Recommendations:
334334
- Avoid linking to external documentation; links can break.
335335

336336
- Javadoc and all valid Doxygen comments are stripped from Doxygen source code
337-
previews (`STRIP_CODE_COMMENTS = YES` in [Doxyfile.in](doc/Doxyfile.in)). If
337+
previews (`STRIP_CODE_COMMENTS = YES` in [Doxyfile.in](/doc/Doxyfile.in)). If
338338
you want a comment to be preserved, it must instead use `//` or `/* */`.
339339

340340
### Generating Documentation
@@ -1335,8 +1335,7 @@ Release notes should be written for any PR that:
13351335

13361336
Release notes should be added to a PR-specific release note file at
13371337
`/doc/release-notes-<PR number>.md` to avoid conflicts between multiple PRs.
1338-
All `release-notes*` files are merged into a single
1339-
[/doc/release-notes.md](/doc/release-notes.md) file prior to the release.
1338+
All `release-notes*` files are merged into a single `release-notes-<version>.md` file prior to the release.
13401339

13411340
RPC interface guidelines
13421341
--------------------------

test/functional/test-shell.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,11 @@ We can also log custom events to the logger.
123123
```
124124

125125
**Note: Please also consider the functional test
126-
[readme](../test/functional/README.md), which provides an overview of the
126+
[readme](/test/functional/README.md), which provides an overview of the
127127
test-framework**. Modules such as
128-
[key.py](../test/functional/test_framework/key.py),
129-
[script.py](../test/functional/test_framework/script.py) and
130-
[messages.py](../test/functional/test_framework/messages.py) are particularly
128+
[key.py](/test/functional/test_framework/key.py),
129+
[script.py](/test/functional/test_framework/script.py) and
130+
[messages.py](/test/functional/test_framework/messages.py) are particularly
131131
useful in constructing objects which can be passed to the bitcoind nodes managed
132132
by a running `TestShell` object.
133133

test/lint/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Then you can use:
3030

3131
| Lint test | Dependency |
3232
|-----------|:----------:|
33-
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
34-
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
35-
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
36-
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
37-
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
38-
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
39-
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
33+
| [`lint-python.py`](/test/lint/lint-python.py) | [flake8](https://github.com/PyCQA/flake8)
34+
| [`lint-python.py`](/test/lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
35+
| [`lint-python.py`](/test/lint/lint-python.py) | [mypy](https://github.com/python/mypy)
36+
| [`lint-python.py`](/test/lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
37+
| [`lint-python-dead-code.py`](/test/lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
38+
| [`lint-shell.py`](/test/lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
39+
| [`lint-spelling.py`](/test/lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
4040

4141
In use versions and install instructions are available in the [CI setup](../../ci/lint/04_install.sh).
4242

0 commit comments

Comments
 (0)