steemit / devportal

Steem Platform Developer Documentation.
https://developers.steem.io
MIT License
122 stars 74 forks source link

DP: Meta: Evaluate moving to codewalks #376

Open relativityboy opened 6 years ago

relativityboy commented 6 years ago

Our tutorials are and look good Do we want to move to a code-walk format or are we happy with their functionality now?

Supporting Codewalk ex: https://golang.org/doc/codewalk/functions/

Possible Path: It may be valuable to utilize/update our DP "consumable repo" standards to support auto-generation of code-walks via a tool that compiles properly annotated src files and README files into a code-walk. This would also allow injection of the annotated code into a more traditional style tutorial (as the DP is currently)

AC

inertia186 commented 6 years ago

Might be possible in a custom rake command that adds/monitors codewalk markup. I believe that was one goal with "right-code" that we removed because it was so broken.