Skip to content

Commit

Permalink
Merge #2278
Browse files Browse the repository at this point in the history
2278: Publish on master only r=newhoggy a=newhoggy

* Add link to online API docs from README with build instructions
* Fix presentation of links in README

Co-authored-by: John Ky <john.ky@iohk.io>
  • Loading branch information
iohk-bors[bot] and newhoggy committed Jan 14, 2021
2 parents 54c0c85 + 40b51a6 commit 9699a56
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
1 change: 1 addition & 0 deletions .github/workflows/github-page.yml
Expand Up @@ -93,6 +93,7 @@ jobs:
path: ./haddocks

- name: Deploy documentation to gh-pages 🚀
if: github.ref == 'refs/heads/master'
run: |
git fetch origin gh-pages:gh-pages
git config --local user.email "$(git show --format="%aN" | head -n 1)"
Expand Down
14 changes: 11 additions & 3 deletions README.rst
Expand Up @@ -433,11 +433,19 @@ Native Token Pre-Production Environment

Thanks for your interest in building native tokens on Cardano. To help you get started we have compiled a handy list of resources:

`Cardano Forum discussion forum <https://forum.cardano.org/c/developers/cardano-tokens/150>`
`Cardano Forum discussion forum <https://forum.cardano.org/c/developers/cardano-tokens/150>`_

`Developer Documentation for Native Tokens <https://developers.cardano.org/en/development-environments/native-tokens/native-tokens/>`
`Developer Documentation for Native Tokens <https://developers.cardano.org/en/development-environments/native-tokens/native-tokens/>`_


**Please note that over the holiday period, technical support for the pre-production environment and token builder tool will be extremely limited**. Support is unavailable between the dates of 23rd - 27th December and 31 December - 3rd January inclusive. Outside these hours, our technical and community teams will be periodically checking in on the GitHub repo and dedicated Cardano Forum discussion forum, to expedite any urgent queries or requests. We encourage you to draw on community feedback and support as much as possible.

If you require test ada during this period, please `fill out this form <https://input-output.typeform.com/to/KmeBcnDa>` and you will be sent your test ada. Note that until the wallet backend is fully integrated, this is an essentially manual process and there may therefore be some delay before the request is processed. For technical reasons, it may only be possible to fund newly created addresses that have been properly set up on the Pre-Production Environment. Unfortunately, since the form only records payment addresses, it will not be possible to contact you if the funding attempt fails, or to notify you that it has succeeded. Please check that you have submitted the address correctly, and retry if you need to
If you require test ada during this period, please `fill out this form <https://input-output.typeform.com/to/KmeBcnDa>`_ and you will be sent your test ada. Note that until the wallet backend is fully integrated, this is an essentially manual process and there may therefore be some delay before the request is processed. For technical reasons, it may only be possible to fund newly created addresses that have been properly set up on the Pre-Production Environment. Unfortunately, since the form only records payment addresses, it will not be possible to contact you if the funding attempt fails, or to notify you that it has succeeded. Please check that you have submitted the address correctly, and retry if you need to

API Documentation
=================
The API documentation is published `here <https://input-output-hk.github.io/cardano-node/>`_.

The documentation is built with each push, but is only published from `master` branch. In order to
test if the documentation is working, build the documentation locally with `./scripts/haddocs.sh` and
open `haddocks/index.html` in the browser.

0 comments on commit 9699a56

Please sign in to comment.