Difference between revisions of "(progress) porting of the official documentation"
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
If you plan to contribute then please first read the [[Contributing|contributing page.]] | If you plan to contribute then please first read the [[Contributing|contributing page.]] | ||
| − | == Part 1: the documentation == | + | == Part 1: the documentation (version 0.6.37) == |
'''<span style="text-decoration: underline;">DONE:</span>''' | '''<span style="text-decoration: underline;">DONE:</span>''' | ||
*Introduction - completed (moved to the welcome page) | *Introduction - completed (moved to the welcome page) | ||
| Line 14: | Line 14: | ||
*[[Code]] - 75% (missing formatting) | *[[Code]] - 75% (missing formatting) | ||
*[[Tokens]] - 75% (missing formatting) | *[[Tokens]] - 75% (missing formatting) | ||
| − | *[[Advanced Usage]] - | + | *[[Advanced Usage]] - 25% |
| − | *[[Tips and | + | *[[Tips and Tricks]] - 25% |
| − | *[[ | + | *[[How It Works]] - 25% |
| − | *[[API | + | *[[API Reference]] - 0% |
| − | *[[Tools]] - | + | *[[Tools]] - 25% |
| + | *on each above, add a "Where to go from here" at the end that links to the next one | ||
*Go through all the above again and update the links to run.network to links to parts of this wiki where appropriate - 0% | *Go through all the above again and update the links to run.network to links to parts of this wiki where appropriate - 0% | ||
Latest revision as of 00:41, 29 April 2023
This page is to coordinate community efforts to port the official documentation from https://run.network/docs/ into this wiki
If you plan to contribute then please first read the contributing page.
Part 1: the documentation (version 0.6.37)
DONE:
- Introduction - completed (moved to the welcome page)
- Getting Started
- Jigs
TODO:
- Code - 75% (missing formatting)
- Tokens - 75% (missing formatting)
- Advanced Usage - 25%
- Tips and Tricks - 25%
- How It Works - 25%
- API Reference - 0%
- Tools - 25%
- on each above, add a "Where to go from here" at the end that links to the next one
- Go through all the above again and update the links to run.network to links to parts of this wiki where appropriate - 0%
Part 2: the tutorials
DONE:
- Tutorial 1 - Intro to jigs that run on Bitcoin: Mocknet and Web Console
- Tutorial 2 - Running jigs on Bitcoin Mainnet, Part 1
- Tutorial 3 - Running jigs on Bitcoin Mainnet, Part 2
- Tutorial 4 - Running a Pay Server on Bitcoin Testnet
- Tutorial 5 - Setting icons for your jigs: emojis and SVG images
- Tutorial 6 - Taking security seriously with sandboxing for jigs on Bitcoin
- Tutorial 7 (extra) - Private key management
TODO:
- Go through all the tutorials again and make sure links go to this wiki where appropriate - 0%
Part 3: the blog articles
TODO:
- Port the blog articles as archives, these can be useful if/when the run website closes: https://blog.run.network/
