Wanted: a clear, systematic tutorial text + examples of progressive complexity

Open
#370 22 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, python
Domain
documentation, web-dev

Research direction

Review Transcrypt's existing tutorial material and examples before defining the scope. The proposed tutorial should progress from nearly trivial code to compiler switches and pragmas, JavaScript-library interaction, webserver use, and HTML or DOM work. Done means a clear, systematic text with examples suitable for novices.

Written by the indexing model from the issue text.

Description

STATE: under construction SUB: documentation

What Transcrypt is still missing is a good, systematic tutorial text + examples, suitable for novices.

The combination of a new programming language, a compiler with many switches and pragma's, interaction with JavaScript libraries, and having to deal with a webserver, as well as HTML or the DOM on a client can be daunting at first.

Although I've considered approaching O'Reilly Media and writing a tutorial myself, I don't expect to find the time currently, as working on Transcrypt itself takes up much all most all of my spare time.

Writing a good educational text is far from easy, as I know from my experience as a Technical Computer Sciences teacher at the Rotterdam University of Applied Sciences. Still a good tutorial, starting out at an almost trivial level, would substantially lower the threshold for newcomers to Transcrypt.

So if anyone still remembers how difficult it was to write your first lines of code and on top of this likes to teach and can explain clearly in plain English, he/she's invited to give it a try. If you're embarking on this, let me know, to prevent duplication of effort.

Kind regards
Jacques

Dominant language
Python
Stars
2.9k
Forks
218
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from TranscryptOrg/Transcrypt

All issues in TranscryptOrg/Transcrypt

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.