Turn 'core functionality' into a cheatsheet

未关闭
#681 7 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

从现有的“core functionality”文档开始,将其中的演示与链接的 Learn X in Y Minutes 格式进行比较。将其重构为简明的速查表,为每个部分链接更详尽的文档,并将内容拆分为单独的页面,以便新手可以浏览各项功能,用户也可以快速温习语法。

由索引模型根据 Issue 内容生成。

描述

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

  1. new users can quickly gauge what Turing is capable of doing

  2. existing users who just need a refresher on syntax can see it immediately without wading through loads of text

  3. the text is grouped onto individual pages nicely

主要语言
Markdown
星标
238
派生
107
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TuringLang/docs 的其他 Issue

查看 TuringLang/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。