From 5c22586e028e1b247380b2c7fe22aaf7a78ebefe Mon Sep 17 00:00:00 2001 From: thephez Date: Thu, 4 Jan 2018 10:18:14 -0500 Subject: [PATCH] More doc updates --- README.md | 4 ++-- docs/contributing-to-developer-documentation.md | 4 +++- docs/setting-up-your-environment.md | 16 ++++++++-------- doxygen/README.md | 2 +- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b1e44278..0e346752 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ The following quick guides will help you get started: --> + [Working with GitHub](https://github.com/thephez/dash.org/blob/master/docs/working-with-github.md) + [Setting Up Your Environment](https://github.com/thephez/dash.org/blob/master/docs/setting-up-your-environment.md) - -+ [Miscellaneous / Other](https://github.com/thephez/dash.org/blob/master/docs/miscellaneous.md) diff --git a/docs/contributing-to-developer-documentation.md b/docs/contributing-to-developer-documentation.md index 607afb48..597942bf 100644 --- a/docs/contributing-to-developer-documentation.md +++ b/docs/contributing-to-developer-documentation.md @@ -1,10 +1,11 @@ ## Developer Documentation Most parts of the documentation can be found in the -[_includes](https://github.com/bitcoin-dot-org/bitcoin.org/tree/master/_includes) +[_includes](https://github.com/thephez/dash.org/tree/master/_includes) directory. Updates, fixes and improvements are welcome and can submitted using [pull requests](#working-with-github) on GitHub. + **Style Guide**: For better consistency, the [style guide](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-Style-Guide) diff --git a/docs/setting-up-your-environment.md b/docs/setting-up-your-environment.md index 7b81ca1d..93e46219 100644 --- a/docs/setting-up-your-environment.md +++ b/docs/setting-up-your-environment.md @@ -19,6 +19,14 @@ To build the site, you need to go through a one-time installation procedure that takes 15 to 30 minutes. After that you can build the site an unlimited number of times with no extra work. +#### Source Code Documentation + +The https://dash-docs.github.io site includes Doxygen generated documentation +for the [Dash Core](https://github.com/dashpay/dash/) source code. To +generate it, copy the files from `doxygen/` into the Dash Core `doc/` folder +and run `doxygen doc/Doxyfile-dashdocs`. Then copy the output (Dash Core's +`doc/doxygen/html/` folder) into the `en/doxygen/` folder of this project. + ##### Install The Dependencies Before building the site, you need to install the following @@ -91,14 +99,6 @@ long time to install on some systems, so be patient. Once Bundle completes successfully, you can preview or build the site. -##### Source Code Documentation - -The https://dash-docs.github.io site includes Doxygen generated documentation -for the [Dash Core](https://github.com/dashpay/dash/) source code. To -generate it, copy the files from /doxygen into the Dash Core /doc folder -and run `doxygen doc/Doxyfile-dashdocs`. Then copy the output (Dash Core's -/doc/doxygen/html/ folder) into the /en/doxygen/ of this project. - ##### Preview The Site To preview the website in your local browser, make sure you're in the diff --git a/doxygen/README.md b/doxygen/README.md index f3de911a..d73a43db 100644 --- a/doxygen/README.md +++ b/doxygen/README.md @@ -2,6 +2,6 @@ Doxygen Info ===================== To generate a version of the Dash Core source documentation specific -to this site, copy the files in this folder to the /doc/ folder of +to this site, copy the files in this folder to the `doc/` folder of the Dash Core repository and then run `doxygen doc/Doxyfile-dashdocs` from the root folder of the Dash Core repository.