Difference between revisions of "(progress) porting of the official documentation"

From RunWiki
Jump to: navigation, search
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page is to coordinate community efforts to port the official documentation from [https://run.network/docs/ https://run.network/docs/] into this wiki
 
This page is to coordinate community efforts to port the official documentation from [https://run.network/docs/ https://run.network/docs/] into this wiki
  
 +
If you plan to contribute then please first read the [[Contributing|contributing page.]]
  
−
*Introduction - 0%
+
== Part 1: the documentation (version 0.6.37) ==
−
*Getting Started - 5%
+
'''<span style="text-decoration: underline;">DONE:</span>'''
−
**[[Installing the run sdk|Installing the run sdk]] - completed<br>
+
*Introduction - completed (moved to the welcome page)
−
**[[Creating and_loading_jigs|creating and loading jigs]] - 5%
+
*Getting Started
−
*Jigs - 0%
+
**[[Installing the run sdk]]<br>
−
*Code - 0%
+
**[[Creating and_loading_jigs|creating and loading jigs]]&nbsp;
−
*Tokens - 0%
+
*[[Jigs]]
−
*Advanced Usage - 0%
+
 
−
*Tips and tricks - 0%
+
<span style="text-decoration: underline;">'''TODO:'''</span>
−
*how it works - 0%
+
*[[Code]] - 75% (missing formatting)
−
*API reference - 0%
+
*[[Tokens]] - 75% (missing formatting)
−
*Tools - 0%
+
*[[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 ==
 +
'''<span style="text-decoration: underline;">DONE:</span>'''
 +
* [[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]]
 +
'''<span style="text-decoration: underline;">TODO:</span>'''
 +
*Go through all the tutorials again and make sure links go to this wiki where appropriate - 0%
 +
 
 +
== Part 3: the blog articles ==
 +
'''<span style="text-decoration: underline;">TODO:</span>'''
 +
*Port the blog articles as archives, these can be useful if/when the run website closes: [https://blog.run.network/ https://blog.run.network/]

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:

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:

TODO:

  • Go through all the tutorials again and make sure links go to this wiki where appropriate - 0%

Part 3: the blog articles

TODO:

Retrieved from "https://wiki.runcraft.io/index.php?title=(progress)_porting_of_the_official_documentation&oldid=473"