Skip to content

Add AI agent files#2253

Open
imnasnainaec wants to merge 4 commits intodevelopfrom
pb-ext-agents
Open

Add AI agent files#2253
imnasnainaec wants to merge 4 commits intodevelopfrom
pb-ext-agents

Conversation

@imnasnainaec
Copy link
Copy Markdown
Collaborator

@imnasnainaec imnasnainaec commented May 4, 2026

Generated with Claude Code's /init, lightly edited, and renamed as AGENTS.md for general use.

Devin: https://app.devin.ai/review/sillsdev/languageforge-lexbox/pull/2253

@imnasnainaec imnasnainaec self-assigned this May 4, 2026
@imnasnainaec imnasnainaec added the 🟩Low Low-priority PR label May 4, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 1ad5c974-d02a-4715-a6ca-9e22b34bef33

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds AI agent guidance documentation for the platform.bible-extension repository. It introduces AGENTS.md with comprehensive setup, architecture, and contribution details, and creates CLAUDE.md as a reference pointer to the main guide.

Changes

AI Agent Guidance Documentation

Layer / File(s) Summary
Main Agent Guidance
platform.bible-extension/AGENTS.md
New 77-line documentation covering extension purpose, setup requirements, npm commands, architecture overview, extension lifecycle, key modules, build pipeline, PAPI patterns, and contribution expectations.
Agent Discovery Reference
platform.bible-extension/CLAUDE.md
New single-line file containing @AGENTS.md pointer for agent discoverability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

Poem

🐰 A bunny hops through docs so bright,
With AGENTS.md shining light,
CLAUDE says "follow yonder way!"—
Guides for AI, come what may! 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add AI agent files' directly and accurately describes the changeset, which adds AGENTS.md and CLAUDE.md documentation files for AI agent guidance.
Description check ✅ Passed The description is related to the changeset, explaining that the files were generated with Claude Code's /init and edited/renamed as AGENTS.md, which matches the added documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pb-ext-agents

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Comment thread platform.bible-extension/AGENTS.md Outdated
Comment thread platform.bible-extension/AGENTS.md Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@platform.bible-extension/AGENTS.md`:
- Around line 15-18: Update the fenced code block so it declares the language
for syntax highlighting (e.g., change the opening backticks to ```bash); locate
the block containing the two commands "npm core:install" and "npm install" in
AGENTS.md and replace the opening fence with a language-specified fence
(```bash) to ensure proper shell highlighting and tooling support.
- Around line 22-24: The fenced code block containing the line `task
build-fw-lite` should include a language specifier for proper highlighting;
change the triple-backtick fence to specify a shell language (e.g., use ```bash)
so the code block around `task build-fw-lite` reads as a bash/shell snippet.
🪄 Autofix (Beta)

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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: eff6ae39-203f-4cb6-ac33-50f0599dae2f

📥 Commits

Reviewing files that changed from the base of the PR and between a0db9ac and 8a57f94.

📒 Files selected for processing (2)
  • platform.bible-extension/AGENTS.md
  • platform.bible-extension/CLAUDE.md

Comment thread platform.bible-extension/AGENTS.md Outdated
Comment on lines +15 to +18
```
npm core:install
npm install
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language specifier to code block.

The fenced code block should specify bash or shell for proper syntax highlighting and tooling support.

📝 Proposed fix
-```
+```bash
 npm core:install
 npm install
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 15-15: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @platform.bible-extension/AGENTS.md around lines 15 - 18, Update the fenced
code block so it declares the language for syntax highlighting (e.g., change the
opening backticks to bash); locate the block containing the two commands "npm core:install" and "npm install" in AGENTS.md and replace the opening fence with a language-specified fence (bash) to ensure proper shell highlighting and
tooling support.


</details>

<!-- fingerprinting:phantom:triton:puma -->

<!-- d98c2f50 -->

<!-- This is an auto-generated comment by CodeRabbit -->

Comment thread platform.bible-extension/AGENTS.md Outdated
Comment on lines +22 to +24
```
task build-fw-lite
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language specifier to code block.

The fenced code block should specify bash or shell for proper syntax highlighting and tooling support.

📝 Proposed fix
-```
+```bash
 task build-fw-lite
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>

[warning] 22-22: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @platform.bible-extension/AGENTS.md around lines 22 - 24, The fenced code
block containing the line task build-fw-lite should include a language
specifier for proper highlighting; change the triple-backtick fence to specify a
shell language (e.g., use ```bash) so the code block around task build-fw-lite
reads as a bash/shell snippet.


</details>

<!-- fingerprinting:phantom:triton:puma -->

<!-- d98c2f50 -->

<!-- This is an auto-generated comment by CodeRabbit -->

@imnasnainaec imnasnainaec marked this pull request as draft May 5, 2026 18:22
@imnasnainaec imnasnainaec marked this pull request as ready for review May 5, 2026 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants