galacticcouncil / hydration-docs

Hydration-docs

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Built using Docusaurus 2.

hydration-docs's Issues

[performance_benchmark] needs reworking

https://docs.hydradx.io/performance_benchmark

is out of date

Task: Substitute LRNA with H2O

I believe you now call the omnipool representation "H2O" (water hydrates) instead of "LRNA", so you should update it everywhere you find it in the docs, especially at this page, which is linked from the UI in "Learn more about the risks" everytime a user deposits in the Omnipool (and will then possibily receive H2O, not LRNA):

[i18n-de-es-ru-cn-fr] translate staking_rewards.md

Improve claim images

Add new screenshots and improve existing ones for the claim screen

[i18n-de-es-ru] update performance_benchmark

adept @vgantchev latest changes, code snippets already replaced

Validator setup

Generate address locally by using subkey

How to use subkey to create HydraDX (ss58) address?

https://github.com/paritytech/substrate/tree/master/bin/utils/subkey

HydraDX (ss58) specific instruction to generate address in terminal

Add Node Monitoring Guide

Provide easy-to-use Prometheus, Substrate Exporter, Node Exporter, Grafana integration.

[start_nominating] add change nominations explanation

https://docs.hydradx.io/start_nominating/#03-check-the-status-of-your-nominations

Please add information how to change nominations by adding/removing validators.
https://support.polkadot.network/support/solutions/articles/65000170911-how-do-i-change-my-validators-

@vgantchev

Tokenomics docs overhaul

Docs currently: https://github.com/galacticcouncil/HydraDX-docs/blob/main/docs/tokenomics.md

Tokenomics page needs an overhaul to include:

• text explanation of the distribution breakdown and schedule, max supply, etc
• utility of HDX token
• two-token model with LRNA & HDX
• links to any other explainers in docs i.e. protocol fee burning LRNA or sending LRNA to HDX subpool

Some useful resources that can feed the doc:

https://hydradx.substack.com/p/feeding-every-hydrahead
https://hydradx.substack.com/p/hydradx-omnipool-part-2
https://hydradx.substack.com/p/hydradx-omnipool-part-1

docusaurus i18n setup

I need to configure i18n in docusaurus.
Russian translations already present.

Check grammar and interpunction

[IMPROVEMENT] mobile menu is misleading

Right now the mobile main-menu just shows docs, languages and website link.
The real navigation menu is "hidden" in a separat menu button on the lower right corner.
We should check if it's possible to have it combined in one place.

Check links

https://github.com/marketplace/actions/markdown-link-check

Just try build in pipeline and it should check links

Polish translation

Hi Everyone,

We are ready with Polish translation on local branch ElavateCV/i18n-pl squashed and rebased with current main, but we don't have permission. Can you provide us a short instruction how to make a pull request?

Best Regards,

[i18n-de-fr-es-cn-pl-ru] add payout

see #68

[IMPROVEMENT] update claim guide for gen2

Replace "HydraDX Snakenet" with "HydraDX Snakenet Gen2" and put new account-setup screen.
Adjustment needs to be done for all languages.

[i18n-de-fr-es-cn-pl-ru] add note to identity

see #72

Add introduction to HydraDX

intro.md needs a lot of <3

[start_nominating] typos and incorrect in content

https://docs.hydradx.io/start_nominating/#02-nominate-a-validator

The following passage needs to be rephrased @vgantchev :

After clicking on the Nominate button you should see a popup called nominate validators. Here you can select on or more validators to nominate from the list of available validators. If you select multiple validators, you can disperse your stake in different proportions to the validators of your choice.

Update docs to remove order batching, reflect pool token rebrand

[i18n-de-es-ru-cn-fr] translate intro.md

Use correct IL graph

We are using an IL graph with incorrect axis labels in this page:
https://docs.hydradx.io/omnipool_impermanent_loss/
Correct IL graph can be found in this notebook:
https://github.com/galacticcouncil/HydraDX-simulations/blob/main/hydradx/notebooks/Omnipool/vault/ImpermanentLossAnalysis.ipynb

More explicit docs for identity

Some people are concerned to set identity because there is a field called legal name. We should explicitly state that none of the fields are required and that it's recommended for node runners to set at least mail so we can contact them if anything is wrong.

[start_nominating] add information about rebonding if accidentally unbonded

some users unbonded their staked funds by accident in the past.
we should add information on rebonding before the unbonding period ends.
this can be done by submitting staking.rebond in https://polkadot.js.org/apps/#/extrinsics

[i18n-de-fr-es-cn-pl-ru] rewrite snakenet

see #67

Document Omnipool V1

[i18n-fr] translation

[i18n-de] update claim guide

according to @vgantchev latest changes

Full First Draft of Documentation Text

https://www.notion.so/Documentation-9698c76d723c4bbba54fcbd8a52750fd

[i18n-de-es-ru] add adjust nomination to start_nominating

[claim] add network hint

https://docs.hydradx.io/claim/#02-create-hdx-address

In this step please include a hint to specifically use "HydraDX Snakenet" as network, as "Allow use on any chain" will cause trouble.
@vgantchev

[/]Improve Intro Page

The Docs into page absolutely needs some rework!
Brief overview and description would be fine.
Recent content isn't nice to look at:

Intro
Welcome to HydraDX docs.

Hopefully, we can make this place a great resource for learning about HydraDX together.

Collator setup

add instructions related to the upcoming migration from snakenet to parachain (hydra-dx 12+) targeted for validators transitioning to collators and new collators