Open tweakch opened 3 years ago
And let me say that I really like the portal so far... the you've done a fantastic job @katomm @Mercurial @Nazeim @rcmorano @AndrewWestberg and everyone I forgot...
this issue makes me so happy! I will be reviewing this in the next couple days, thank you so much!
Improve Structure for "Integrating Cardano" section
The structure of Integrate Cardano should be improved. Below ere are the issues I found. I aggregate them all here as to not spam the Issues Tab with my own issues. You can create new issues and assign them to me if you like, I'll do them whenever I have some time to spare.
Sub issues
No content in Overview
IMHO the integrate-cardano/Overview.md needs to talk about what this section is about.
cardano-node
,cardano-cli
andcardano-wallet
) and present the structure of the following guides.Inconsistent Headings
The used headings in the articles
creating-wallet-faucet.md
,listening-for-payments-cli.md
andlistening-for-payments-wallet.md
begin onlevel 3
instead oflevel 2
breaking md001Current
Proposed
Throughout the article (f.e. in
### Create simple transaction
paragraphs) we use Emphasis (**Generate recovery phrase**
) instead of Heading (#### Generate recovery phrase
) breaking md036Long articles
creating-wallet-faucet.md
is a very long article and talks about the following topics:cardano-cli
cardano-cli
cardano-wallet
The following subissues could help improve readability.
cardano-cli
and Creating simple transaction withcardano-wallet
respectivelyTestnet Faucet Limit
If one works through the entire article he will first submit 1000 ada to the wallet he created using
cardano-cli
. Then (20 minutes later) he will create a new wallet usingcardano-wallet
and again request 1000 ada from the faucet which has a payout limit for 1000 ada / day.cardano-cli
andcardano-wallet
).Oddball solution
We have the focus on two components:
cardano-cli
andcardano-wallet
. We try to give the reader an idea on how to integrate them.We use two approaches to present this information to him. theme-based approach and component-based approach
creating-wallet-faucet.md
)listening-for-payments-cli.md
andlistening-for-payments-wallet.md
)I think I like Component-based more because the articles are shorter, but I really don't know what is better.
Don't repeat yourself
The guides contain some repetition. Sometimes this is unavoidable when talking about two components who do very similar things. The improvements should help avoid the unneccesary repetitions.
As an example, we have this paragraph from the
cardano-wallet-faucet.md
This could be moved to the
overview.md
and not be talked about anymore. By removing this paragraph we could move all headings one layer up which would improve the structure of document further.Typos
Improve current structure (draft)