Skip to content

docs: split hook environment variables section into dedicated reference doc #63

Description

@randlee

Background

docs/agent-tool-use-best-practices.md grew significantly in PR #62 (+365 lines net). The bulk of the growth is in the environment variables / availability matrix section, which is dense reference material distinct from the best-practices guidance.

Recommendation

Extract the following into a dedicated docs/hook-environment-variables.md reference doc:

  • Environment Variables: Availability by Context (availability matrix table)
  • CLAUDE_PROJECT_DIR / CLAUDE_PLUGIN_ROOT / CODEX_PROJECT_DIR reference
  • get_project_dir() / get_plugin_root() helper function patterns
  • cwd vs stable root identity semantics

agent-tool-use-best-practices.md would keep a short summary and link to the dedicated doc for the full reference.

Benefits

  • Best-practices doc stays focused on patterns and guidance
  • Reference material is easier to find and cite independently
  • Easier to update as new captures back or refine env var claims

Notes

  • Evidence sourcing (schook captures, sc-test-harness baseline) should stay with the reference doc
  • The availability matrix rows for Frontmatter Hook and Named Teammate are still marked untested — a good prompt to revisit once more captures land

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions