steemit / devportal-tutorials-js

Tutorials for the Developer Portal
MIT License
44 stars 43 forks source link

JS-T: META: Standardize the structure of all tutorials #69

Closed relativityboy closed 6 years ago

relativityboy commented 6 years ago

Standardize the tutorials based on the outcome of steemit/devportal#159

AC

inertia186 commented 6 years ago

One thing we have to figure out is what to do with right-code from the perspective of the rake task (https://github.com/steemit/devportal/issues/163). Options:

  1. Keep right-code and try to parse the tutorial README.md file, splitting the paragraphs of the tutorial to the left and code to the right.
  2. Leave right-code blank and just manually move code over to right-code if it makes sense.
  3. Create a right-code.js file just for code examples that belong in right-code.
  4. Eliminate right-code and just import the README.md as is.

I've been working on option 1, but I don't think we'll like the results. Some tutorials have only one code example per heading, and that works great. But some tutorials have multiple code examples per heading and they just get moved over to right-code, making the flow of the paragraph awkward.

Personally, I'd go with option 4.

relativityboy commented 6 years ago

We have determined "right code" will be signified by code blocks created with ~~~

Specification is in the -js repository

feruzm commented 6 years ago

I will start first 3 (get blog, steemconnect, client signing) tutorials and push them to 69-readme-structure branch later today

relativityboy commented 6 years ago

I added each story as an AC at the top. We can check them off as they get done.

relativityboy commented 6 years ago

I will take 04_get_posts.