Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate cargo-linkcheck and fix broken links. #100

Merged
merged 3 commits into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/merge-acceptance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/render-site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ There are two github CI workflows:

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

### Other prerequisites

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

[output.linkcheck]

[preprocessor.graphviz]
command = "mdbook-graphviz"
after = ["links"]
Expand Down
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

Expand All @@ -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}}
Expand Down
2 changes: 1 addition & 1 deletion src/introduction/status-and-next-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Up @@ -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)]().