Skip to content

Web Railshooter from CR Build #234

Closed
@ShMcK

Description

@ShMcK

I believe It’s possible to build both a VSCode and web compatible standard for tutorials. You could write the tutorial once and run in as a web “railshooter” style walkthrough, and on vscode with CodeRoad.

Tutorials are stored in commits and markdown

  1. A setup commit + markdown
  2. A solution commit
  3. B setup commit + markdown
  4. B solution commit

For web, you could generate a page with content and tests by stopping at steps 1 and 3 and generating a build for each.

Benefits include:

  • Reduced duplication across code for each page
  • Testable verification of unit tests and a solution in the build process. You can demonstrate that changing code at step A does not break later steps.
  • Can run on two platforms with a single build tool

How a build could work

  1. Capture the list of commits from markdown in order. Run tests using git by cherry-picking commit by commit and running processes.
  2. At each step setup, generate the boilerplate required for a static web page (markdown, cumulative commit code)
  3. At each step solution, run unit tests to ensure tests pass, otherwise fail with a clear error message

How to edit

Editing can be managed the same as in CodeRoad:

  • Checkout a new branch (eg “v1.21”)
  • Interactive rebase to make changes
  • Run tests
  • Add the new branch name to the markdown file

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestquestionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions