8000 [Upstream] [Docs] Overhaul documentation files by lyricidal · Pull Request #264 · PRCYCoin/PRCYCoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Upstream] [Docs] Overhaul documentation files #264

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

Merged
merged 18 commits into from
Sep 19, 2022

Conversation

lyricidal
Copy link

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.

from PIVX-Project/PIVX#920

Also, remove the now redundant README_osx.md file
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
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.
@Jamesj66 Jamesj66 merged commit 5f64823 into develop Sep 19, 2022
@Jamesj66 Jamesj66 deleted the upstream-doc_update-pr920 branch September 19, 2022 20:57
@lyricidal lyricidal added the Upstream Upstream backports/fixes label Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Upstream Upstream backports/fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0