Skip to content

docs: index agent guidance with canonical source links #5

@rianjs

Description

@rianjs

Goal

Convert this repo's agent guidance into thin indexes instead of duplicating shared conventions.

Canonical references should point to GitHub as the source of truth, with adjacent local paths listed only as workspace conveniences.

Example:

Source of truth: https://github.com/open-cli-collective/cli-common/blob/main/docs/release.md
Local convenience copy, if present: ../cli-common/docs/release.md

Scope

Repo-specific notes

  • Use the existing concise guidance as the newer-pattern baseline, but add local-path fallback wording beside canonical GitHub URLs.

Acceptance Criteria

  • Agent entrypoints are short indexes, not duplicated convention containers.
  • Every shared-standard local path has a paired GitHub source-of-truth URL.
  • Repo-specific architecture and commands remain easy to find.
  • Cross-repo conventions live in shared docs or automation, not copied into each repo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions