8000 fix: link fixes in specs actors (#995) · filecoin-project/specs@d6814fe · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit d6814fe

Browse files
yiannisbothugomrdias
yiannisbot
and
hugomrdias
authored
fix: link fixes in specs actors (#995)
Co-authored-by: Hugo Dias <mail@hugodias.me>
1 parent 71f3720 commit d6814fe

File tree

13 files changed

+30
-27
lines changed

13 files changed

+30
-27
lines changed

‎README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,19 @@ You can find examples in the `config.toml`
4545
source = "actors"
4646
target = "content/modules/actors"
4747
```
48-
This makes files from external repos available for Hugo rendering.
48+
This makes files from external repos available for Hugo rendering and allows for linking to up-to-date files that are directly pulled from other repositories.
49+
50+
The configuration above gives the following information:
51+
52+
- `path`: gives the repository you want to mount content from.
53+
- `source`: the folder from the repository referenced in the `path` that we want to mount into our local Hugo filesystem. This is the "root" seen from your Hugo site where you pull content from. In the above case, this means that the source that will be mounted is `https://github.com/filecoin-project/specs-actors/actors/`.
54+
- `target`: the folder in your local Hugo site where the mounted content appears. In our case folder `content` is where we include all Hugo content.
55+
56+
Putting everything together in an example: if you want to link to the file `xyz.go` from `https://github.com/filecoin-project/specs-actors/actors/xyz-folder/xyz.go`, from any file within the local folder `content` (or any of its subfolders), then with the above configuration you have to include:
57+
58+
```
59+
{{<embed src="/modules/actors/xyz-folder/xyz.go" lang="go">}}
60+
```
4961

5062
These modules can be updated with
5163

@@ -258,4 +270,4 @@ $\line{9}{\bi}{\return \BinTreeProof_c \thin \{\ \leaf, \thin \root, \thin \path
258270
- [editor](https://mermaid-js.github.io/mermaid-live-editor)
259271
- [Pan/Zoom for SVG](https://github.com/anvaka/panzoom)
260272
- [Icons](https://css.gg/)
261-
- [Working with submodules](https://github.blog/2016-02-01-working-with-submodules/)
273+
- [Working with submodules](https://github.blog/2016-02-01-working-with-submodules/)

‎content/algorithms/crypto/randomness.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,7 @@ GetRandomness(dst, l, s):
8989
return H(buffer)
9090
```
9191

92-
{{< hint danger >}}
93-
Issue with readfile
94-
{{< /hint >}}
95-
96-
{{<embed src="/docs/actors/actors/crypto/randomness.go" lang="go">}}
92+
{{<embed src="/modules/actors/crypto/randomness.go" lang="go">}}
9793
{{<embed src="/systems/filecoin_blockchain/struct/chain/chain.go" lang="go">}}
9894

9995
## Entropy to be used with randomness

‎content/systems/filecoin_blockchain/storage_power_consensus/storage_power_actor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ dashboardTests: 0
1111

1212
## `StoragePowerActorState` implementation
1313

14-
{{<embed src="/docs/actors/actors/builtin/storage_power/storage_power_actor_state.go" lang="go" >}}
14+
{{<embed src="/modules/actors/builtin/power/power_state.go" lang="go" >}}
1515

1616
## `StoragePowerActor` implementation
1717

18-
{{<embed src="/docs/actors/actors/builtin/storage_power/storage_power_actor.go" lang="go" >}}
18+
{{<embed src="/modules/actors/builtin/power/power_actor.go" lang="go" >}}
1919

2020
## The Power Table
2121

‎content/systems/filecoin_markets/storage_market/storage_deal/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ This section describes the storage deal data type and a technical outline for de
1919

2020
## Data Types
2121

22-
{{< embed src="/docs/actors/actors/builtin/storage_market/storage_deal.go" lang="go" >}}
22+
{{< embed src="/modules/actors/builtin/market/deal.go" lang="go" >}}
2323

‎content/systems/filecoin_markets/storage_market/storage_market_actor.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,12 @@ dashboardTests: 0
1414

1515
## `StorageMarketActorState` implementation
1616

17-
{{<embed src="/docs/actors/actors/builtin/storage_market/storage_market_actor_state.go" lang="go" >}}
17+
{{<embed src="/modules/actors/builtin/market/market_state.go" lang="go" >}}
1818

1919
## `StorageMarketActor` implementation
2020

21-
{{<embed src="/docs/actors/actors/builtin/storage_market/storage_market_actor.go" lang="go" >}}
21+
{{<embed src="/modules/actors/builtin/market/market_actor.go" lang="go" >}}
2222

23-
## `StorageMarketActor` implementation
24-
25-
{{<embed src="/docs/actors/actors/builtin/storage_market/storage_market_actor.go" lang="go" >}}
2623

2724
## Storage Deal Collateral
2825

‎content/systems/filecoin_mining/storage_mining/storage_miner_actor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ dashboardTests: 0
1111

1212
## `StorageMinerActorState` implementation
1313

14-
{{<embed src="/docs/actors/actors/builtin/storage_miner/storage_miner_actor_state.go" lang="go" >}}
14+
{{<embed src="/modules/actors/builtin/miner/miner_state.go" lang="go" >}}
1515

1616
## `StorageMinerActorCode` implementation
1717

18-
{{<embed src="/docs/actors/actors/builtin/storage_miner/storage_miner_actor.go" lang="go" >}}
18+
{{<embed src="/modules/actors/builtin/miner/miner_actor.go" lang="go" >}}

‎content/systems/filecoin_token/multisig/multisig_actor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ dashboardTests: 0
99
# Multisig Actor
1010
---
1111

12-
{{<embed src="/docs/actors/actors/builtin/multisig/multisig_actor.go" lang="go" >}}
13-
{{<embed src="/docs/actors/actors/builtin/multisig/multisig_actor_state.go" lang="go" >}}
12+
{{<embed src="/modules/actors/builtin/multisig/multisig_actor.go" lang="go" >}}
13+
{{<embed src="/modules/actors/builtin/multisig/multisig_state.go" lang="go" >}}

‎content/systems/filecoin_vm/indices/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@ dashboardTests: 0
1111
---
1212

1313
Indices are a set of global economic indicators computed from State Tree and a collection of pure functions to compute policy output based on user state/action. Indices are used to compute and implement economic mechanisms and policies for the system. There are no persistent states in Indicies. Neither can Indices introduce any state mutation. Note that where indices should live is a design decision. It is possible to break Indices into multiple files or place indices in different actors once all economic mechanisms have been decided on. Temporarily, Indices is a holding file for all potential macroeconomic indicators that the system needs to be aware of.
14-
15-
{{<embed src="/docs/actors/actors/runtime/indices/indices.go" lang="go" >}}

‎content/systems/filecoin_vm/runtime/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A syntactically valid receipt has:
2323

2424
## `vm/runtime` interface
2525

26-
{{<embed src="/docs/actors/actors/runtime/runtime.go" lang="go" >}}
26+
{{<embed src="/modules/actors/runtime/runtime.go" lang="go" >}}
2727

2828
## `vm/runtime` implementation
2929

@@ -35,4 +35,4 @@ A syntactically valid receipt has:
3535

3636
## Exit codes
3737

38-
{{<embed src="/docs/actors/actors/runtime/exitcode/vm_exitcodes.go" lang="go" >}}
38+
{{<embed src="/modules/actors/runtime/exitcode/common.go" lang="go" >}}

‎content/systems/filecoin_vm/sysactors/account_actor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ dashboardTests: 0
1010
# AccountActor
1111
---
1212

13-
{{<embed src="/docs/actors/actors/builtin/account/account_actor.go" lang="go" >}}
13+
{{<embed src="/modules/actors/builtin/account/account_actor.go" lang="go" >}}

‎content/systems/filecoin_vm/sysactors/cron_actor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ dashboardTests: 0
1010
# CronActor
1111
---
1212

13-
{{<embed src="/docs/actors/actors/builtin/cron/cron_actor.go" lang="go">}}
13+
{{<embed src="/modules/actors/builtin/cron/cron_actor.go" lang="go">}}

‎content/systems/filecoin_vm/sysactors/init_actor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ dashboardTests: 0
1010
# InitActor
1111
---
1212

13-
{{<embed src="/docs/actors/actors/builtin/init/init_actor.go" lang="go">}}
13+
{{<embed src="/modules/actors/builtin/init/init_actor.go" lang="go">}}

‎content/systems/filecoin_vm/sysactors/reward_actor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ RewardActor is where unminted Filecoin tokens are kept. RewardActor contains a `
1515

1616
A `Reward` struct contains a `StartEpoch` that keeps track of when this `Reward` is created, `Value` that represents the total number of tokens rewarded, and `EndEpoch` which is when the reward will be fully vested. `VestingFunction` is currently an enum to represent the flexibility of different vesting functions. `AmountWithdrawn` records how many tokens have been withdrawn from a `Reward` struct so far. Owner addresses can call `WithdrawReward` which will withdraw all vested tokens that the investor address has from the RewardMap so far. When `AmountWithdrawn` equals `Value` in a `Reward` struct, the `Reward` struct will be removed from the `RewardMap`.
1717

18-
{{<embed src="/docs/actors/actors/builtin/reward/reward_actor.go" lang="go">}}
18+
{{<embed src="/modules/actors/builtin/reward/reward_actor.go" lang="go">}}

0 commit comments

Comments
 (0)
0