[Doc Drift] README extract flags table missing `--remove-stale`

Open Beginner friendly
#250 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
94/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
cli, documentation

Research direction

Start with the apiops extract flags table in README.md, then compare it with docs/commands/extract.md line 69 and the apiops extract --help output mentioned in the issue. Done means the README table includes --remove-stale with wording consistent with the documented behavior.

Written by the indexing model from the issue text.

Description

type:documentation
What drifted

The apiops extract flags table in README.md is missing the --remove-stale flag. The flag exists in the CLI (confirmed by apiops extract --help) and is documented in docs/commands/extract.md, but was not added to the README summary table when it was introduced in commit 570ca00 ("fix: reconcile stale extraction artifacts safely").

Source of truth

apiops extract --help output:

--remove-stale    Remove stale managed artifacts in the selected scope

docs/commands/extract.md line 69:

| `--remove-stale` | boolean | false | No | Remove stale managed artifacts in the selected filter and workspace scope after a fully successful extraction |
Affected documentation
  • README.md — the ### \apiops extract`section's flags table (currently lists only--resource-group, --service-name, --output, --filter, --no-transitive`)
Suggested update

Add a row for --remove-stale to the README extract flags table:

| --remove-stale | | Remove stale managed artifacts after a fully successful extraction |

Generated by Documentation Freshness Check — System Policy · 38.1 AIC · ⌖ 6.97 AIC · ⊞ 6.2K · ◷

Dominant language
TypeScript
Stars
29
Forks
10
Avg merge
1d 13h
Merged PRs (30d)
23

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.

More from Azure/apiops-cli

All issues in Azure/apiops-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.