[Docs] Overhaul documentation files #920
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
Fuzzbawls
force-pushed
the
2019_doc-update
branch
from
e698a89
to
08ce48a
Compare
Closed
Warrows
approved these changes
Jun 17, 2019
Also, remove the now redundant README_osx.md file
Fuzzbawls
force-pushed
the
2019_doc-update
branch
from
08ce48a
to
0c6b8d7
Compare
Mainly punctuation and styling changes. Added a section about rebasing pull requests.
Updated to consider more recent versions and features of the tor router (automatic hidden service creation/deletion).
Fix some typos and refresh with more current information.
Typo fixes and update python to python3 in sample commands
This file contains explicit dependency information used for release builds (version, link, etc).
Changed to markdown table layout for ease of reading. Removed old bitcoin-only information for older versions that we never used.
Fix namings, outdated links, and sample commands
Added more details regarding the purpose, writing, and use of the regression test suite.
Minor formatting and grammatical changes. Remove stale reference to the aarch64 gitian descriptor.
grammatical fixes
Add TOC and expand on style guidelines as well as better describe testing cases.
Prep for new/renamed scripts
Adds guidelines for adding new translation strings in the code
Update the in-tree README.md with the contents of `doc/unit-tests.md`, and delete the redundant doc file.
These doc files are either completely redundant (documentation exists in-wallet/in-rpc, or more comprehensive guides elsewhere), or were left over fragments from when the code fork was done.
Fuzzbawls
force-pushed
the
2019_doc-update
branch
from
0c6b8d7
to
d24742c
Compare
Fuzzbawls
added a commit
that referenced
this pull request
Jun 18, 2019
d24742c Remove redundant docs (Fuzzbawls) 007cc8c Update src/test/README.md (Fuzzbawls) d2af959 Introduce translation_strings_policy.md (Fuzzbawls) 019b8f4 Update contrib/devtools/README.md (Fuzzbawls) 2bc9d1b Update developer-notes.md (Fuzzbawls) d1a65fd Update dnsseed-policy.md (Fuzzbawls) 0b5c0c2 Update release-process.md (Fuzzbawls) 9335a10 Update test/functional/README.md (Fuzzbawls) 20f2513 Update doc/README.md (Fuzzbawls) 5b4f73d Clean up whitespace in Doxyfile.in (Fuzzbawls) 3cea76b Update and reformat init.md (Fuzzbawls) 2f5efbd Reformat files.md (Fuzzbawls) df0d2ba Introduce dependencies.md (Fuzzbawls) 785b61c Update zmq.md (Fuzzbawls) 231f28e Update translation_process.md (Fuzzbawls) c5f6822 Update tor.md (Fuzzbawls) b7d0ec7 Fix markdown in REST-interface.md (Fuzzbawls) 4fa4cc4 Update Contributing guidelines (Fuzzbawls) a544132 Update build notes (Fuzzbawls) Tree-SHA512: ab422791c3e43d6e455d648c9b6b30943c176e03d2a0702135184108c8887bb39e4bb9c51bab9f9a04a130a297f8db879563e3b45f010c6b1f34482122b78681
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 is a sweeping update of the majority of the in-tree documentation files. While efforts were made to be exhaustive, it may not be 100% complete.
References to non-existent python or shell scripts will be rectified in a subsequent pull-request (in order to not mix documentation and code changes). I've kept commits as atomic as possible, usually only affecting a single file to ease the review process.