Skip to content

docs: sync examples index references#122

Merged
rosspeili merged 1 commit into
ARPAHLS:mainfrom
choucaleb602-commits:docs/sync-examples-index-117
May 25, 2026
Merged

docs: sync examples index references#122
rosspeili merged 1 commit into
ARPAHLS:mainfrom
choucaleb602-commits:docs/sync-examples-index-117

Conversation

@choucaleb602-commits
Copy link
Copy Markdown
Contributor

Description

Syncs the example-script references introduced by the examples index follow-up:

  • updates docs/usage/agent_loops.md so the quick matrix no longer contradicts examples/README.md
  • adds a PR-template checkbox for maintaining examples/README.md when runnable scripts change
  • updates the documentation-only workflow row to mention examples/README.md for runnable-script additions, renames, or removals

This PR was prepared with AI assistance under human supervision. I kept the change small and included the checks I ran below.

Type of Change (Matches Issue Templates)

  • Skill Proposal: New Skill (Contains manifest.yaml, skill.py, and instructions.md)
  • Bug Report Fix: Non-breaking change which fixes an execution error or framework bug
  • Doc Fix: Documentation Update
  • Framework Feature / RFC Updates: Core Framework Update (Changes to base_skill.py, loader.py, etc.)

Checklist (all PRs)

  • My code follows the Agent Code of Conduct.
  • I have run python -m flake8 . and pytest tests/ locally (or the subset relevant to this change).
    • python -m flake8 . could not run because flake8 is not installed in this local Python environment.
    • python -m pytest tests/ -q stopped during collection because optional dependency anthropic is not installed for tests/skills/office/test_pdf_form_filler.py.
    • Relevant focused check python -m pytest tests/test_cli.py -q passed.
  • examples/README.md is updated if this PR adds, renames, or removes a runnable script under examples/.
    • No runnable scripts were added, renamed, or removed; the existing index was used as the source of truth.

New or updated skill

Not applicable; this PR does not add or modify a skill bundle.

Constitution & Safety

Documentation-only change. No skill logic, runtime behavior, secrets, dependencies, or external service calls are changed.

Checks run

  • git diff --check passed
  • Target path sanity check for examples/README.md, docs/usage/agent_loops.md, docs/contributing/ai_native_workflow.md, .github/PULL_REQUEST_TEMPLATE.md, and docs/introduction.md passed
  • python -m pytest tests/test_cli.py -q passed: 8 passed
  • python -m pytest tests/ -q blocked by missing optional anthropic dependency during collection
  • python -m flake8 . blocked because flake8 is not installed locally

Related Issues

Fixes #117

@rosspeili
Copy link
Copy Markdown
Contributor

Thanks @choucaleb602-commits, This fixes #117, scope looks right, and this is merge-ready from my side. Appreciate the follow-through after #107. <3

@rosspeili rosspeili merged commit 18335ac into ARPAHLS:main May 25, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Sync agent_loops matrix with examples index and close contributor doc gaps (follow-up to #100 / #107)

2 participants