docs: add minimal architecture flow diagrams to README, introduction,…#217
Conversation
… and agent loops (ARPAHLS#210)
|
Thanks for picking up #210, @meghana922007, the diagrams are a solid start. Before merge, a few tweaks:
Happy to merge after those, nice first docs contribution <3 |
…ict in CHANGELOG.md
Label optional card.json, add Step 1 mini-pipeline, fan out model adapters, move direct-path Mermaid out of blockquote, and cross-link README How it works.
|
Thanks @meghana922007, great work on #210 and the review follow-up. I pushed one small maintainer commit on your branch so we can merge without a follow-up docs PR:
We’ll merge once CI is green. Very nice first contribution <3 Congrats! |
|
Thank you so much for the detailed feedback and for taking the time to polish the diagrams! I really appreciate all the guidance throughout the review process. This was a great learning experience, and I’m excited to contribute more in the future. |
|
The pleasure was mine @meghana922007. Please feel free to explore more good first issues around docs or other sections if you want. Happy to assign to you low hanging fruits. |
Description
This PR implements the following updates to the documentation as requested in the review comments:
Agent Loops Diagram & Table Updates (
docs/usage/agent_loops.md):agent_loops.mdto use the correctbundle["class"]().execute(args)format instead of the outdatedSkillClass().execute(args)to match step 2.Introduction Flowchart Updates (
docs/introduction.md):card.jsonas an optional bundle file alongsidemanifest.yaml,instructions.md, andskill.py.Type of Change (Matches Issue Templates)
manifest.yaml,skill.py, andinstructions.md)base_skill.py,loader.py, etc.)Checklist (all PRs)
python -m flake8 .,pytest skills/(orskillware test), andpytest tests/locally (or the subset relevant to this change).CHANGELOG.mdupdated under[Unreleased]if this PR changes user-visible behavior.examples/README.mdis updated if this PR adds, renames, or removes a runnable script underexamples/.Related Issues
Fixes #210