Cleanup developer docs #646
Merged
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
The Bitcoin Core release notes don't directly apply to unit-e. We will have our own release notes. Upstream release notes are available from the Bitcoin Core repository at https://github.com/bitcoin/bitcoin/tree/master/doc/release-notes. Signed-off-by: Cornelius Schumacher <[email protected]>
* Replace `UnitE` by `Unit-e` * Replace `UnitE Core` by `unit-e` Signed-off-by: Cornelius Schumacher <[email protected]>
* Remove information which does not apply to unit-e * Add reference to Bitcoin Core copyright * Add note about docs being inherited from upstream Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
* Add introduction * Remove versioning information and only keep the info which is valid for the current version Signed-off-by: Cornelius Schumacher <[email protected]>
We will need to add out own release notes once we start doing releases. Remove the Bitcoin Core release notes for now. Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
* Fix API version number to reflect what is in the code * Fix links to BIPs * Remove example implementation which only exist for Bitcoin Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
Signed-off-by: Cornelius Schumacher <[email protected]>
|
Some of the changes, especially the naming changes, need some adaptions of clonemachine so that the next upstream sync doesn't create too many conflicts. There is an open WIP pull request to adapt the naming (https://github.com/dtr-org/clonemachine/pulls), and a few issues to adapt the other cases (dtr-org/unit-e-clonemachine#25, dtr-org/unit-e-clonemachine#23, dtr-org/unit-e-clonemachine#21). |
Signed-off-by: Cornelius Schumacher <[email protected]>
|
ACK add0411 |
scravy
reviewed
Feb 19, 2019
Signed-off-by: Cornelius Schumacher <[email protected]>
Ruteri
approved these changes
Feb 21, 2019
castarco
approved these changes
Feb 21, 2019
This was referenced Feb 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR cleans up the developer documentation in the
docdirectory. It fixes naming, URLs, and adapts texts to unit-e.The BIPs file, references to the mailing list, and the Windows build data need a follow up (see #641, #640, #639). I would like to consider that out of the scope of this pull request, though.
The release and translation process documents need an update as well but we can better do that when we have defined these processes and done releases and translations. There is a note in these files in this regard.
The pull request contains a series of patches. There is a bit of context in the commit messages. It might be easier to review the pull request by looking at the commits instead of the complete file diff. It's up to your preferences, though :-)