joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 01:36:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add doxygen config files used to generate source docs

Browse source 
Update misc docs
This commit is contained in:
thephez 2018-01-04 10:06:31 -05:00
parent 86ea1643e4
commit 61dcf900a6
10 changed files with 2883 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/setting-up-your-environment.md
View file

@ -2,7 +2,7 @@
#### Preview Small Text Changes
Simple text changes can be previewed live on bitcoin.org. You only need to click
Simple text changes can be previewed live on dash-docs.github.io. You only need to click
anywhere on the page and hold your mouse button for one second. You'll then be
able to edit the page just like a document. Changes will be lost as soon as the
page is refreshed.
@ -11,7 +11,7 @@ page is refreshed.
For anything more than simple text previews, you will need to build the
site. If you can't do this yourself using the instructions below, please
[open a pull request](https://github.com/bitcoin-dot-org/bitcoin.org/compare)
[open a pull request](https://github.com/thephez/dash.org/compare)
with your suggested change and one of the site developers will create a preview
for you.
@ -76,11 +76,11 @@ Use that program to install bundle:
**Install the Ruby dependencies**
Ensure you checked out the site repository as described in [Working with
GitHub](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/working-with-github.md).
GitHub](https://github.com/thephez/dash.org/blob/master/docs/working-with-github.md).
Then change directory to the top-level of your local repository (replace
`bitcoin.org` with the full path to your local repository clone):
`dash.org` with the full path to your local repository clone):
cd bitcoin.org
cd dash.org
And install the necessary dependencies using Bundle:
@ -91,10 +91,18 @@ 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
`bitcoin.org` directory and run the following command:
`dash.org` directory and run the following command:
make preview
@ -110,7 +118,7 @@ Visit the indicated URL in your browser to view the site.
##### Build The Site
To build the site exactly like we do for the deployment server, make
sure you're in the `bitcoin.org` directory and run:
sure you're in the `dash.org` directory and run:
make
@ -172,13 +180,13 @@ For a list of languages, look in the `_translations` directory.
You can publish your previews online to any static hosting service.
[GitHub pages](https://pages.github.com/) is a free service available to
all GitHub users that works with Bitcoin.org's site hierarchy.
all GitHub users that works with dash-docs.github.io's site hierarchy.
Before building a preview site, it is recommended that you set the
environmental variable `BITCOINORG_BUILD_TYPE` to "preview". This will
enable some content that would otherwise be hidden and also create a
robots.txt file that will help prevent the site from being indexed by
search engines and mistaken for the actual Bitcoin.org website.
search engines and mistaken for the actual dash-docs.github.io website.
In the bash shell, you can do this by running the following command line
before building you preview: