Turn 'core functionality' into a cheatsheet
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 238
- Forks
- 107
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 2
Description
core functionality includes some not very core functionality. also the demonstrations are a bit too complex imo
I think it makes sense to turn it into a cheatsheet, 'learn Turing in 5 minutes' kind of thing (see https://learnxinyminutes.com/), and each section in it should link to more thorough docs on the page
that way it becomes something where
-
new users can quickly gauge what Turing is capable of doing
-
existing users who just need a refresher on syntax can see it immediately without wading through loads of text
-
the text is grouped onto individual pages nicely
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing “core functionality” documentation and compare its demonstrations with the linked Learn X in Y Minutes format. Restructure it as a concise cheatsheet, link each section to more thorough documentation, and separate the content into individual pages so newcomers can scan capabilities and users can quickly refresh syntax.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100