This repository has been archived by the owner on Mar 28, 2023. It is now read-only.
Doc Drift: Fix a variety of doc issues, primarily around cross-references #561
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Asciidoctor allows relfileprefix to be combined with cross-references that end in .adoc and a proper anchor to correctly resolve both in a same-file and in separate-file compilation passes. Leverage this across the document includes.
mhluongo
reviewed
Apr 5, 2020
docs/bonding/index.adoc
Outdated
| BTC in custody (with overcollateralization factored in), a BTC value drop | ||
| against the bonded asset translates in lower fees for Signers. Note that this | ||
| does not create any issue for TBTC reserves, but it makes the system less | ||
| attractive to signers looking to earn interest via fees on their assets. |
There was a problem hiding this comment.
You didn't do this, but we shouldn't call it "interest" as it isn't... maybe just "attractive to signers earning fees on their assets"? Anyway fine to kick, nit
| operated by MakerDAO. MakerDAO has both ETHUSD and BTCUSD feeds; these are | ||
| combined to make a single ETHBTC price. | ||
| collateral backs all tBTC signers. For tBTC v1, the feed will be built on a | ||
| BTCETH |
There was a problem hiding this comment.
Nope. PR is #545.
| collateral backs all tBTC signers. For tBTC v1, the feed will be built on a | ||
| BTCETH | ||
| https://developer.makerdao.com/feeds/[https://docs.makerdao.com/smart-contract-modules/oracle-module/oracle-security-module-osm-detailed-documentation] | ||
| from MakerDAO, currently operated by MakerDAO. | ||
|
|
||
| The minimal price feed design is specified completely by the interface below: | ||
|
|
There was a problem hiding this comment.
In this interface still accurate?
There was a problem hiding this comment.
Probably not, but that’s for another day.
|
@mhluongo this is ready for another pass! |
These were TODOs from some time ago that are still very much worth introducing for clarity.
These constants, which are all tracked in constants.adoc are important for cross-referencing against mainnet system constants.
Some of these no longer make sense since the spec has been restructured, others are left as exercises for the reader.
ECDSA fraud proofs are the only supported types at this point.
1 task
Spec-ial Todos: Clean up most remaining spec TODOs
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initiated by #549 (h/t @claveros), the following things should be true:
Fixes #549.
See #554.