Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Refactor tutorial docs and tutorial repos

See original GitHub issue

Docs lives now in repo. It is pretty easy to add new pages just by adding md files in content folder. if you need to add new subfolder to side-nav define it at There is npm start script there to test website locally. Don’t sure how to structure tutorial repo. But let’s start with private sub package on monorepo like

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:27 (9 by maintainers)

github_iconTop GitHub Comments

fopsdevcommented, Oct 22, 2016

looks nice. i’ve already started cerebral tutorial without knowing that 😃 maybe best if i just finish it and then we can iterate on it btw. if i have some wip for cerebral-website which i would like to have backuped, can i push it to a new branch? (i’m not a git jedi yet 😉

fopsdevcommented, Oct 21, 2016

The Existing Tutorial Structure:

Tutorial: Introduction

Concepts to learn: From State to View

Tutorial: Next Step

Concepts to learn: From View to State or how to change State

Tutorial: Advanced

Concepts to learn: Routing

Tutorial: Get started

Concepts to learn: Immutable,Mutable, Viewlayers

Goals for the new tutorials:

  • User should achieve something very quickly and easely. This also means that some concepts like mutable, immutable, strict-mode will be left out. I really liked the “How would i handle” - part from the “old” website. so thats maybe the place for those guys.
  • For those users coming from Angular or other MVC frameworks the advantages should be clear (eg. path change tracking against value/reference/whatever - checking, maintaining a complex app, …)
  • after finishing the tutorials the user should think: “hey, i’m ready! lets develop my app with cerebral! 😃”

Proposal for the new Structure:

Tutorial: Get started

(it’s already done by christian, i might change a few things) Concepts to learn: From State to View and Structuring your State, Viewlayers Imo we could leave out immutable, mutable at this stage (its maybe more confusing for beginners)

Tutorial: Update State (Signals)

Concepts to learn: From View to State or how to change State, Debugger Using Signals (also Async using http provider), Actions, Factories, Paths

Tutorial: Providers

Concepts to learn: Create your own Provider

Tutorial: Routing

Concepts to learn: Routing, it’s just a provider an changing state (so not really something new to learn here but this fact maybe underlines the simplicity of cerebraljs2 and should give the following impression to the user: “hey, i’m ready! 😃” )

Questions before i can start:

Should we use create-react-app for all the repos? I had quite a good experience with it I could also create a branch for Inferno (which i personally prefer but has less users) and mention it for the peeps that would like to try it out. So i would focus on react for all the samples on the website. will http provider also be under packages some fine day? It’s also a good thing that the routing tutorial is at the end because the api is not set in stone right now as i understand. I’ll use the newest versions to start (can’t wait to check out the tagged templates (operators))

I’ll start tomorrow later in the evening and i’m sure there will be more questions. Since i’m still a bit a “green banana” when it comes to webdev i would need for sure some pro tips when it comes to linting, codestyle, … but this could be part of further iterations as well.

So please drop your feedback here, it’s mostly welcome.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Refactoring guide - GitLab Docs
Refactoring guide. This document is a collection of techniques and best practices to consider while performing a refactor.
Read more >
clean-code-ml/ at master - GitHub
How to refactor a Jupyter notebook. What is "refactoring". Refactoring is changing code to make it easier to understand and modify without changing...
Read more >
Refactor Go code using Comby - Sourcegraph docs
In your terminal, run this command: · Wait for it to run and compute the changes for each repository. · Open the preview...
Read more >
Refactoring Python Applications for Simplicity
In this step-by-step tutorial, you'll learn how to refactor your Python application to be simpler and more maintainable and have fewer bugs.
Read more >
refactoring101 — refactoring101 0.1 documentation
The goal of this tutorial is to bridge that gap. We'll demonstrate how to use Python language features – functions, modules, packages and...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found