search

stellar / stellar-docs

Documentation for Stellar
https://developers.stellar.org
Apache License 2.0
54 stars 123 forks source link

Add guides #490

Closed leighmcculloch closed 4 months ago

leighmcculloch commented 1 year ago

I think need to add a "Guides" section that provide education about how to do certain things at a higher level, and across a broader set of tools including wallets.

Right now the docs are really narrowly focused on specific areas. At the moment only one area: building the contracts themselves. Soon another narrow area: building dapps.

We don't have any documentation that tackle the bigger topics that @tyvdh has been highlighting need addressing:

The idea with the Guides is that they form higher level education, but are still focused on step-by-step instruction.

These guides ideally need to cover some categories, and within those categories there are specific more narrow tasks we need to be teaching:

I imagine there are many more topics than this, so anyone is welcome to please update this list.

cc @tomerweller @tyvdh

leighmcculloch commented 1 year ago

@tyvdh Is this something we still need? The issue is pretty old, and may not represent current thinking or a need we still have. We can close if not.

kalepail commented 1 year ago

Yes it is imo. Complex asset management is still a bit of black box as far as I'm aware. Would be curious what @Julian-dev28 thinks as he's been going through this.

Julian-dev28 commented 1 year ago

I think most of these tasks have been addressed in the current docs:

Category: Asset Issuance How to issue an asset on Stellar How to create a token on Soroban for that asset https://soroban.stellar.org/docs/how-to-guides/stellar-asset-contract#deployment

How to mint https://soroban.stellar.org/docs/how-to-guides/stellar-asset-contract#testing

How to burn / clawback https://soroban.stellar.org/docs/how-to-guides/stellar-asset-contract#interacting-with-classic-stellar-assets

I could add something to the docs to over these cases in more detail if anything

janewang commented 4 months ago

Bri has a doc for the remaining

Asset issuance and management Using assets across Stellar and Soroban

Closing