Documentation issues

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

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

Start with the installation and use page at https://www.transcrypt.org/docs/html/installation_use.html and review the three reported points in sequence. Clarify where the automated_tests and demos/hello directories are after pip installation, correct the localhost URL, and verify that the documented commands work on the described Ubuntu setup.

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

描述

On https://www.transcrypt.org/docs/html/installation_use.html
I did a pip install on Ubuntu 20.04. I found the following things confusing in the documentation:

  1. It's not clear where the .. path starts from in the command "Go to directory ../Transcrypt-/transcrypt/development/automated_tests/transcrypt" (I ultimately found it at "/home/user/.local/lib/python3.8/site-packages/transcrypt/development/automated_tests", and I have no idea how I would have gotten from "../Transcrypt-" to ".local/lib/python3.8/site-packages"
  2. "Open a command prompt in the demos/hello directory and type transcrypt hello." It's not clear where the demos/hello folder is (I ultimately found it at "/home/user/.local/lib/python3.8/site-packages/transcrypt/demos/hello")
  3. "type localhost:8000/hello in the address bar" should say "type http://localhost:8000/hello.html in the address bar" (the lack of .html leads to the python HTTP server giving 404 errors.)
主要语言
Python
星标
2.9k
派生
218
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

TranscryptOrg/Transcrypt 的其他 Issue

查看 TranscryptOrg/Transcrypt 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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