Skip to content

fix(docs): explain in more details activation block & installation steps for skills - #2216

Merged
gagdiez merged 2 commits into
nearai:stagingfrom
denbite:update-skills-doc
Apr 10, 2026
Merged

gagdiez merged 2 commits into
nearai:stagingfrom
denbite:update-skills-doc

Conversation

@denbite

@denbite denbite commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Summary

The skills doc was missing concrete installation instructions (correct path and how to verify) and an explanation of why the activation block is required for the agent to ever pick up a skill.

Change Type

  • Bug fix
  • New feature
  • Refactor
  • Documentation
  • CI/Infrastructure
  • Security
  • Dependencies

Linked Issue

Validation

  • cargo fmt --all -- --check
  • cargo clippy --all --benches --tests --examples --all-features -- -D warnings
  • cargo build
  • Relevant tests pass:
  • cargo test --features integration if database-backed or integration behavior changed
  • Manual testing:
  • If a coding agent was used and supports it, review-pr or pr-shepherd --fix was run before requesting review

Security Impact

Database Impact

Blast Radius

Rollback Plan

Review Follow-Through


Review track:

@github-actions github-actions Bot added scope: docs Documentation size: M 50-199 changed lines risk: low Changes to docs, tests, or low-risk modules labels Apr 9, 2026
@denbite denbite changed the title fix: explain in more detailsactivation block & installation steps for skills fix(docs): explain in more details activation block & installation steps for skills Apr 9, 2026
@github-actions github-actions Bot added the contributor: new First-time contributor label Apr 9, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for skill scoring and installation in docs/capabilities/skills.mdx. The reviewer identified an inaccuracy regarding the default value for the max_context_tokens field, noting that it defaults to 2000 rather than 1 when omitted, and provided a correction for the documentation table.

Comment thread docs/capabilities/skills.mdx Outdated
| `patterns` | Regex patterns. Each match adds significant weight — use for intent-specific phrases. |
| `tags` | Short labels for broad domain matching (e.g. `blockchain`, `cli`). |
| `exclude_keywords` | Veto list — if any appear in the message, the skill scores zero regardless of other matches. |
| `max_context_tokens` | Token budget this skill may consume per turn. Omitting it leaves the skill with a 1-token budget, effectively excluding it. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description for max_context_tokens appears to be incorrect. According to the default_max_context_tokens function in crates/ironclaw_skills/src/types.rs, omitting this field causes it to default to 2000, not 1.

Please update the documentation to reflect the correct default value.

| `max_context_tokens` | Token budget this skill may consume per turn. If omitted, this defaults to 2000. |

Comment thread docs/capabilities/skills.mdx Outdated
@gagdiez
gagdiez merged commit 55cdbf2 into nearai:staging Apr 10, 2026
5 checks passed
@ironclaw-ci ironclaw-ci Bot mentioned this pull request Apr 10, 2026
@ironclaw-ci ironclaw-ci Bot mentioned this pull request Apr 18, 2026
theredspoon pushed a commit to theredspoon/ironclaw that referenced this pull request Jun 21, 2026
…steps for skills (nearai#2216)

* fix: explain in more details`activation` block & installation steps for skills

* chore: apply review from gemini

---------

Co-authored-by: Guille <gagdiez.c@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor: new First-time contributor risk: low Changes to docs, tests, or low-risk modules scope: docs Documentation size: M 50-199 changed lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants