Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

DP: Meta: Evaluate moving to codewalks #376

Open
4 tasks
relativityboy opened this issue Nov 8, 2018 · 1 comment
Open
4 tasks

DP: Meta: Evaluate moving to codewalks #376

relativityboy opened this issue Nov 8, 2018 · 1 comment
Labels
5 - SW Steemworks Points spike

Comments

@relativityboy
Copy link
Contributor

relativityboy commented Nov 8, 2018

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

  • evaluate and put decision in # Results
  • describe where codewalks will live within website (we want to keep inline tutorials)
  • if answer is no, close codewalk meta stories. in Steemworks backlog.
  • if answer is yes, add to prioritized roadmap
@inertia186
Copy link
Contributor

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.

@relativityboy relativityboy added the 5 - SW Steemworks Points label Nov 14, 2018
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
5 - SW Steemworks Points spike
Projects
None yet
Development

No branches or pull requests

2 participants