docs: clarify host context integration paths - #350
Open
stgomoyaa wants to merge 1 commit into
Open
Conversation
Contributor
|
Hey @stgomoyaa thanks for this, and welcome to Skillware <3 First, I would advice you to claim the issue by commenting on #348, so you can be assigned. This keeps PR reviews clean and focused, especially for good first issues. Then I am happy to accept this PR as it is clean, adheres to repo standards and contributing guide, after you fix some minor nits:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a focused host-context decision guide for integrations that use full Directives, brief registry lines, or progressive loading.
docs/usage/skill_chaining.mdadds the six-row decision table, five-term glossary, progressive-disclosure callout, and explicit non-goals.docs/usage/README.mdpoints the shared-patterns section to the new decision guide.docs/usage/agent_loops.mdexplains theSkillContext.execute()andprepare()boundary and updates the misleading code comment.CHANGELOG.mdrecords the user-facing documentation update under[Unreleased].This change was developed with AI assistance and was reviewed and tested locally.
Type of Change
skills/skills/skillware/core/loader, env, adaptersskillware/cli.py,docs/usage/cli.mdexamples/*.py,examples/README.mdpyproject.toml,MANIFEST.inChecklist (all PRs)
Closes #348)python -m black --check .andflake8pass locallypytest skills/andpytest tests/pass locallyCHANGELOG.mdupdated under[Unreleased]for this user-facing documentation changeexamples/README.mdupdated if this PR adds, renames, or removes a runnable scriptpytest tests/test_skill_docs.pywhen catalog Usage Examples or provider snippets changedEvidence
Constitution and safety (skills only)
Not applicable; this PR changes documentation only.
Related Issues
Closes #348