Skip to content

[Doc Drift] README.md apiops init flags table missing --artifact-dir option #194

Closed

Description

@github-actions

What drifted

The apiops init flags table in README.md is missing the --artifact-dir <dir> option. This flag controls the artifact directory path referenced in generated CI/CD pipeline files (default: ./apim-artifacts). It is present in the CLI --help output and fully documented in docs/commands/init.md, but the README quick-reference table lists only 5 of the 6 init flags and silently omits this one.

Source of truth

apiops init --help output includes:

--artifact-dir <dir>      Artifact directory path (default:
                          "./apim-artifacts")

docs/commands/init.md (line 49) correctly documents it:

| `--artifact-dir <dir>` | string | `./apim-artifacts` | No | Artifact directory path |

Affected documentation

  • README.md — the apiops init flags table (the | Flag | Description | table under ### \apiops init``)

Suggested update

Add --artifact-dir <dir> as a row in the README's init flags table, e.g.:

Flag Description
--artifact-dir <dir> Artifact directory path (default: ./apim-artifacts)
--cli-package <path> Path to a local .tgz tarball
--ci <platform> github-actions or azure-devops
--environments <list> Comma-separated environments (e.g. dev,prod)
--non-interactive Skip all prompts
--force Overwrite existing files

Generated by Documentation Freshness Check — System Policy · 42 AIC · ⌖ 9.17 AIC · ⊞ 6.1K · ◷

Activity

  1. added
    squadSquad triage inbox — Lead will assign to a member
    squad:docwriterAssigned to DocWriter (📝 Technical Writer)
    squad:copilotAssigned to @copilot (Coding Agent) for autonomous work
    on Jul 2, 2026
  2. github-actions commented on Jul 2, 2026

    @github-actions
    Author

    📋 Issue Assignment

    Assignee: @EMaher
    Labels applied: squad, squad:docwriter, squad:copilot
    Copilot handoff: squad:copilot applied — the Copilot coding agent will pick this up.

    Matched squad areas

    • Documentation, user guides, diagrams, /docs content → DocWriter (squad:docwriter) — Issue is a README.md documentation drift fix: the apiops init flags table is missing a row for --artifact-dir <dir>. Routing-table examples include "README" and "Markdown docs" — direct match.

    Notes

    No routing uncertainty. This is a pure documentation fix (add one missing row to the README flags table). No CLI code changes are needed — the flag already exists in the CLI and is documented in docs/commands/init.md; only README.md needs updating.

    Generated by Issue Assignment Agent for #194 · 20.8 AIC · ⌖ 6.04 AIC · ⊞ 5.4K · ◷

  3. added a commit that references this issue on Jul 2, 2026
    1540c68
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

DocumentationDocumentation issues or requestsclose:fixedFixed by a previous PR or releasego:yesReady to implementsquadSquad triage inbox — Lead will assign to a membersquad:copilotAssigned to @copilot (Coding Agent) for autonomous worksquad:docwriterAssigned to DocWriter (📝 Technical Writer)

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions