docs: publish Skippy native API reference - #1217
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe PR documents the Skippy native C ABI, adds a generator for validated API reference Markdown, and publishes a generated website page covering 73 exported functions across 13 headers. ChangesSkippy Native API Documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/generate-skippy-api-doc.py`:
- Around line 105-107: Update the macro-processing loop using match.group(1) to
skip header-guard macros such as SKIPPY_H and SKIPPY_*_H before appending to
declarations, while preserving all other SKIPPY_ macro declarations.
- Line 216: Remove the unnecessary f-string prefix from the static backlink
string in the function-index backlink generation. Update the list concatenation
at the RUF005 location to use Ruff-preferred iterable unpacking or an equivalent
non-concatenating construction, preserving the existing output order and
contents.
- Around line 85-99: Update the documentation parsing around file_comment and
the function loop: extract the page header brief from file_comment instead of
HEADER_BRIEFS[path.name], and reject a missing header brief. For each
declaration matched by function_pattern, only use the Doxygen comment whose
closing delimiter is immediately before the LLAMA_API declaration; do not search
all preceding comments, and raise the existing missing-brief error when no
adjacent function brief is present.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 6e609ce1-6277-44e1-9253-e8f9240b9821
📒 Files selected for processing (7)
.agents/skills/llama-stage-patch-changes/SKILL.mdAGENTS.mdscripts/generate-skippy-api-doc.pythird_party/llama.cpp/patches/0015-docs-annotate-Skippy-native-API-headers.patchwebsite/src/_data/docs.jswebsite/src/assets/site.csswebsite/src/docs/pages/skippy-api.md
b498e45 to
38ac03a
Compare
…on-1194' into agent/skippy-native-api-docs # Conflicts: # .agents/skills/llama-stage-patch-changes/SKILL.md # AGENTS.md
| @@ -0,0 +1,261 @@ | |||
| #!/usr/bin/env python3 | |||
38ac03a to
91360b2
Compare
…on-1194' into HEAD # Conflicts: # .agents/skills/llama-stage-patch-changes/SKILL.md # AGENTS.md
22fbab9
into
jd/fix-issue-986-reasoning-effort-on-1194
* Split Skippy by functional boundary * Rebuild llama patch queue by functional boundary * Add explicit standard library includes to Skippy modules * Add explicit tokenization limit dependency * Address Skippy queue review findings * Advertise Skippy chat feature support * Fix split GGUF stage inventory discovery (#1199) * feat: pass reasoning effort through Skippy templates * feat: advertise reasoning efforts in model listings * docs: require Skippy ABI inventories in PRs * docs: clarify Skippy ABI lockstep policy * refactor: remove legacy Skippy chat ABI * fix: stop advertising reasoning effort values * fix: preserve Skippy no-thinking override * docs: publish Skippy native API reference * fix: address Skippy API doc review comments * Split Skippy by functional boundary * Rebuild llama patch queue by functional boundary * Add explicit standard library includes to Skippy modules * Add explicit tokenization limit dependency * Address Skippy queue review findings * Advertise Skippy chat feature support * Fix split GGUF stage inventory discovery (#1199) * feat: pass reasoning effort through Skippy templates * feat: advertise reasoning efforts in model listings * docs: require Skippy ABI inventories in PRs * docs: clarify Skippy ABI lockstep policy * refactor: remove legacy Skippy chat ABI * fix: stop advertising reasoning effort values * fix: preserve Skippy no-thinking override
* feat: pass reasoning effort through Skippy templates * feat: advertise reasoning efforts in model listings * docs: require Skippy ABI inventories in PRs * docs: clarify Skippy ABI lockstep policy * refactor: remove legacy Skippy chat ABI * fix: stop advertising reasoning effort values * fix: preserve Skippy no-thinking override * docs: publish Skippy native API reference (#1217) * Split Skippy by functional boundary * Rebuild llama patch queue by functional boundary * Add explicit standard library includes to Skippy modules * Add explicit tokenization limit dependency * Address Skippy queue review findings * Advertise Skippy chat feature support * Fix split GGUF stage inventory discovery (#1199) * feat: pass reasoning effort through Skippy templates * feat: advertise reasoning efforts in model listings * docs: require Skippy ABI inventories in PRs * docs: clarify Skippy ABI lockstep policy * refactor: remove legacy Skippy chat ABI * fix: stop advertising reasoning effort values * fix: preserve Skippy no-thinking override * docs: publish Skippy native API reference * fix: address Skippy API doc review comments * Split Skippy by functional boundary * Rebuild llama patch queue by functional boundary * Add explicit standard library includes to Skippy modules * Add explicit tokenization limit dependency * Address Skippy queue review findings * Advertise Skippy chat feature support * Fix split GGUF stage inventory discovery (#1199) * feat: pass reasoning effort through Skippy templates * feat: advertise reasoning efforts in model listings * docs: require Skippy ABI inventories in PRs * docs: clarify Skippy ABI lockstep policy * refactor: remove legacy Skippy chat ABI * fix: stop advertising reasoning effort values * fix: preserve Skippy no-thinking override
Summary
Context
This PR is stacked on #1211 and targets
jd/fix-issue-986-reasoning-effort-on-1194.Validation
python3 scripts/generate-skippy-api-doc.py --checkjust website-build-Wall -Wextra -Werror.Summary by CodeRabbit
New Features
Documentation