posit-dev / posit-dev/air

Add a `Features` section to the CLI page on the website

Open
#261 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
446
Forks
32
Avg merge
16h 48m
Merged PRs (30d)
1

Description

I just took air for a spin, but could not find any information here, or on the post website, about how to actually call air from the command line. Moreover, calling

air --help

only tells me I need a COMMAND, but not the list of available commands. It was only after some searching through the docs that I found I could call

air format .

This is not immediately apparent from any of the docs.

Contributor guide

Open the contributing guide

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.

Research direction

Start with the CLI page on the website and compare it with the existing documentation that describes air commands. Add a Features section covering how to invoke air and making the available commands, including air format ., discoverable; done means a new user can identify the command structure from the page.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.