Documentation issues

Open
#773 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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.)
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.