mirror of
https://github.com/seigler/dash-docs
synced 2025-07-26 17:26:12 +00:00
More doc updates
This commit is contained in:
parent
9585875021
commit
5c22586e02
4 changed files with 14 additions and 12 deletions
|
@ -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)
|
+ [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)
|
+ [Setting Up Your Environment](https://github.com/thephez/dash.org/blob/master/docs/setting-up-your-environment.md)
|
||||||
<!--
|
|
||||||
+ [Improving Developer Documentation](https://github.com/thephez/dash.org/blob/master/docs/contributing-to-developer-documentation.md)
|
+ [Improving Developer Documentation](https://github.com/thephez/dash.org/blob/master/docs/contributing-to-developer-documentation.md)
|
||||||
|
+ [Miscellaneous / Other](https://github.com/thephez/dash.org/blob/master/docs/miscellaneous.md)
|
||||||
|
<!--
|
||||||
+ [Assisting with Translations](https://github.com/thephez/dash.org/blob/master/docs/assisting-with-translations.md)
|
+ [Assisting with Translations](https://github.com/thephez/dash.org/blob/master/docs/assisting-with-translations.md)
|
||||||
+ [Managing Wallets](https://github.com/thephez/dash.org/blob/master/docs/managing-wallets.md)
|
+ [Managing Wallets](https://github.com/thephez/dash.org/blob/master/docs/managing-wallets.md)
|
||||||
+ [Adding Events, Release Notes and Alerts](https://github.com/thephez/dash.org/blob/master/docs/adding-events-release-notes-and-alerts.md)
|
+ [Adding Events, Release Notes and Alerts](https://github.com/thephez/dash.org/blob/master/docs/adding-events-release-notes-and-alerts.md)
|
||||||
+ [Adding Blog Posts](https://github.com/thephez/dash.org/blob/master/docs/adding-blog-posts.md)
|
+ [Adding Blog Posts](https://github.com/thephez/dash.org/blob/master/docs/adding-blog-posts.md)
|
||||||
-->
|
-->
|
||||||
+ [Miscellaneous / Other](https://github.com/thephez/dash.org/blob/master/docs/miscellaneous.md)
|
|
||||||
|
|
|
@ -1,10 +1,11 @@
|
||||||
## Developer Documentation
|
## Developer Documentation
|
||||||
|
|
||||||
Most parts of the documentation can be found in the
|
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
|
directory. Updates, fixes and improvements are welcome and can submitted using
|
||||||
[pull requests](#working-with-github) on GitHub.
|
[pull requests](#working-with-github) on GitHub.
|
||||||
|
|
||||||
|
<!--
|
||||||
**Mailing List**: General discussions can take place on the
|
**Mailing List**: General discussions can take place on the
|
||||||
[mailing list](https://groups.google.com/forum/#!forum/bitcoin-documentation).
|
[mailing list](https://groups.google.com/forum/#!forum/bitcoin-documentation).
|
||||||
|
|
||||||
|
@ -12,6 +13,7 @@ directory. Updates, fixes and improvements are welcome and can submitted using
|
||||||
to the [TODO
|
to the [TODO
|
||||||
list](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-TODO).
|
list](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-TODO).
|
||||||
You are also welcome if you want to assign yourself to any task.
|
You are also welcome if you want to assign yourself to any task.
|
||||||
|
-->
|
||||||
|
|
||||||
**Style Guide**: For better consistency, the [style
|
**Style Guide**: For better consistency, the [style
|
||||||
guide](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-Style-Guide)
|
guide](https://github.com/bitcoin-dot-org/bitcoin.org/wiki/Documentation-Style-Guide)
|
||||||
|
|
|
@ -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
|
procedure that takes 15 to 30 minutes. After that you can build the
|
||||||
site an unlimited number of times with no extra work.
|
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
|
##### Install The Dependencies
|
||||||
|
|
||||||
Before building the site, you need to install the following
|
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.
|
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
|
##### Preview The Site
|
||||||
|
|
||||||
To preview the website in your local browser, make sure you're in the
|
To preview the website in your local browser, make sure you're in the
|
||||||
|
|
|
@ -2,6 +2,6 @@ Doxygen Info
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
To generate a version of the Dash Core source documentation specific
|
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`
|
the Dash Core repository and then run `doxygen doc/Doxyfile-dashdocs`
|
||||||
from the root folder of the Dash Core repository.
|
from the root folder of the Dash Core repository.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue