Skip to content

Commit

Permalink
Merge pull request #100 from Electric-Coin-Company/cargo-linkcheck
Browse files Browse the repository at this point in the history
Integrate `cargo-linkcheck` and fix broken links.
daira authored Oct 31, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents 983e903 + 2649133 commit b7166f4
Showing 7 changed files with 15 additions and 6 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/merge-acceptance.yaml
Original file line number Diff line number Diff line change
@@ -10,10 +10,13 @@ jobs:
uses: ts-graphviz/setup-graphviz@v1
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook@0.4.29
tool: mdbook@0.4.35
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook-graphviz@0.1.6
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook-linkcheck@0.7.7
- uses: actions/checkout@v3
- run: mdbook build
- name: Check for Orphaned Files
5 changes: 4 additions & 1 deletion .github/workflows/render-site.yaml
Original file line number Diff line number Diff line change
@@ -21,10 +21,13 @@ jobs:
uses: ts-graphviz/setup-graphviz@v1
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook@0.4.29
tool: mdbook@0.4.35
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook-graphviz@0.1.6
- uses: taiki-e/cache-cargo-install-action@v1
with:
tool: mdbook-linkcheck@0.7.7

# Now get the user content:
- uses: actions/checkout@v3
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -18,6 +18,7 @@ There are two github CI workflows:

- `cargo install mdbook`
- `cargo install mdbook-graphviz`
- `cargo install mdbook-linkcheck`

### Other prerequisites

2 changes: 2 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -12,6 +12,8 @@ build-dir = "./docs"
[output.html]
default-theme = "light"

[output.linkcheck]

[preprocessor.graphviz]
command = "mdbook-graphviz"
after = ["links"]
4 changes: 2 additions & 2 deletions src/introduction/a-path-to-pos-zcash.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# A Path to Proof-of-Stake Zcash

The [TFL](./terminology.md#definition-tfl) design provides a possible first step in transitioning [Zcash](https://z.cash) to a [PoS](./terminology.md#definition-pos) protocol. Here we describe how a transition to PoS relates to "the Zcash roadmap" and how TFL fits into one approach to a PoS transition.
The [TFL](../terminology.md#definition-tfl) design provides a possible first step in transitioning [Zcash](https://z.cash) to a [PoS](../terminology.md#definition-pos) protocol. Here we describe how a transition to PoS relates to "the Zcash roadmap" and how TFL fits into one approach to a PoS transition.

## The Zcash Tech-Tree

@@ -23,7 +23,7 @@ After this transition to pure PoS, there are likely to be future improvements to

Our primary motivation for proposing (at least) two steps is to minimize disruption to usability, safety, security, and the ecosystem during each step.

With this approach, the Zcash Tech Tree with the [TFL](./terminology.md#definition-tfl) approach might look something like this:
With this approach, the Zcash Tech Tree with the [TFL](../terminology.md#definition-tfl) approach might look something like this:

```dot process
{{#include ../diagrams/zcash-tech-tree-tfl-steps.dot}}
2 changes: 1 addition & 1 deletion src/introduction/status-and-next-steps.md
Original file line number Diff line number Diff line change
@@ -46,4 +46,4 @@ This design proposal is being developed by [Electric Coin Company](https://elect

The fine-grained day-to-day goals and tasks for this project are present in [the Zcash Developers Hub](https://zcash.github.io/developers) in the [TFL-focused DAG](https://zcash.github.io/developers/zcash-tfl-dag).

Please also see [Getting Involved](./getting-involved.md) if you are interested in tracking this progress more closely, or in contributing.
Please also see [Get Involved](./get-involved.md) if you are interested in tracking this progress more closely, or in contributing.
2 changes: 1 addition & 1 deletion src/overview.md
Original file line number Diff line number Diff line change
@@ -10,5 +10,5 @@ The integration of the current PoW consensus with the TFL produces a new top-lev

In the following subchapters we introduce the [Design at a Glance](./overview/design-at-a-glance.md), then provide an overview of the major components of the design.

Following this overview chapter, we proceed into a detailed [Protocol Specification](./protocol-specification.md).
Following this overview chapter, we proceed into a detailed [Protocol Specification (TODO)]().

0 comments on commit b7166f4

Please sign in to comment.