Introduction to the command line tutorial
Open
A pull request for this has already been merged.
docs
- Dominant language
- Python
- Stars
- 17.7k
- Forks
- 2.3k
- Avg merge
- 1d 30m
- Merged PRs (30d)
- 18
Description
Developers coming to Click docs may or may not have command line experience. The command line is a big subject with a lot of cross platform differences. A tutorial which targets basic things you can do would be very helpful. The goal is the minimal amount to get started.
Requirements
- Written in myst
- uses Diataxis principles
- Uses docs tabs so can eventually add multiple oses and shells
- roughly 15 minutes for user to complete tutorial
- shows getting operating system information, directory vs file, file path, moving around, making a directory, making a file, editing a file, printing file contents to the terminal, greping something, showing help for a cli
- good quality links to deeper information on the subject
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 by reviewing the existing Click documentation structure and its MyST, Diátaxis, and docs-tab conventions. Create a roughly 15-minute tutorial covering the listed command-line basics across the planned platform and shell tabs, with links to deeper resources; done means all requirements are covered in a coherent beginner path.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100