docs(ai): add AI prompt template guide for engineering tasks

[dealako]

Summary

• Add ai/ai-prompt-template.md with a structured prompt template for engineering tasks
• Includes filled-in examples for adding features, fixing bugs, and refactoring
• Covers writing tips, common mistakes to avoid, and a quick pre-submission checklist
• Fix markdownlint issues across the repository (MD013 line length, MD060 table separator spacing)

Test plan

• Review the rendered Markdown for formatting and readability
• Verify markdownlint passes with no errors

🤖 Generated with Claude Code

[Copilot]

Pull request overview

This PR adds a new documentation file (ai/ai-prompt-template.md) to the ai/ directory, providing a structured prompt template guide for engineering teams using AI coding tools. It fits alongside existing AI-related documentation such as model lists, review guides, and CLI tooling docs.

Changes:

• Adds a reusable prompt template with sections for Task Title, End State, Context, Constraints, and Acceptance Criteria
• Includes three filled-in examples covering feature addition, bug fixing, and refactoring scenarios
• Provides writing tips, common mistakes to avoid, and a quick pre-submission checklist

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9f08d6f4-6e95-43f1-9f44-309adc6d88dd

📥 Commits

Reviewing files that changed from the base of the PR and between 035cde4 and 17c9613.

📒 Files selected for processing (7)

• .markdownlint.json
• expectations/roles-and-responsibilities.md
• lfx_one/ko-build.md
• lfx_one/secrets-management.md
• lfx_one/skills/lfx-v2-backend/references/indexer-patterns.md
• lfx_one/skills/lfx-v2-backend/references/nats-messaging.md
• lfx_one/skills/lfx-v2-backend/references/service-types.md

✅ Files skipped from review due to trivial changes (3)

• lfx_one/skills/lfx-v2-backend/references/nats-messaging.md
• lfx_one/skills/lfx-v2-backend/references/indexer-patterns.md
• lfx_one/secrets-management.md

---

Walkthrough

Adds a new AI prompt template document and applies markdown formatting adjustments across several docs: updates to .markdownlint rules and multiple README/guide files where tables, line-wrapping, and minor whitespace were changed. No functional code or public API changes.

Changes

Cohort / File(s)	Summary
AI Prompt Template ai/ai-prompt-template.md	Added a new, detailed Markdown guide/template for crafting AI prompts with sections (End State, Context, Constraints, Acceptance Criteria, examples, tips, checklist).
Markdown lint config .markdownlint.json	Adjusted MD013 settings: code_blocks: false and tables: false while preserving line_length: 120.
Responsibilities doc formatting expectations/roles-and-responsibilities.md	Reformatted the Responsibility Matrix from split plain-text into a compact Markdown table; content unchanged.
LFx One docs — minor formatting lfx_one/ko-build.md, lfx_one/secrets-management.md	Whitespace and table-separator reformatting; no semantic changes to content or data.
LFx V2 backend references — table formatting lfx_one/skills/lfx-v2-backend/references/indexer-patterns.md, .../nats-messaging.md, .../service-types.md	Replaced or added table header delimiter rows (`

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the primary change: adding an AI prompt template guide. However, it only addresses the main addition and omits the substantial markdownlint fixes across multiple files that constitute a significant part of the changeset.
Description check	✅ Passed	The description is directly related to the changeset, providing a clear summary of the new prompt template guide, examples, tips, and the markdownlint fixes applied across the repository.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ai-prompt-template

📝 Coding Plan

• Generate coding plan for human review comments

---

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

Tip

You can disable sequence diagrams in the walkthrough.

Disable the reviews.sequence_diagrams setting to disable sequence diagrams in the walkthrough.

[coderabbitai]

🧹 Nitpick comments (1)

ai/ai-prompt-template.md (1)

215-224: Add an explicit markdownlint checklist item.

Since linting Markdown is a required repo rule, add a checkbox that explicitly confirms markdownlint-cli2 was run.

Suggested diff

 ## Quick Checklist

 Before submitting your prompt, verify:

 - [ ] End state describes a specific, observable result
 - [ ] Context identifies the relevant files, modules, or areas of the codebase
 - [ ] Constraints define what must not change and what standards apply
 - [ ] Acceptance criteria are concrete and verifiable
 - [ ] The scope maps to a single, reviewable unit of work
 - [ ] Any referenced conventions or patterns include a pointer to an example in the codebase
+- [ ] `markdownlint-cli2 ai/ai-prompt-template.md` passes with no errors

As per coding guidelines, "All Markdown documentation must pass markdownlint validation" and "Lint Markdown files using markdownlint-cli2 ... before committing."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@ai/ai-prompt-template.md` around lines 215 - 224, Add an explicit checklist
item under the "Quick Checklist" section to confirm markdown linting was
executed: update the checklist (the block beneath the "## Quick Checklist"
header) to include a checkbox like " - [ ] markdownlint-cli2 was run and all
files pass" so reviewers can verify that markdownlint-cli2 was run and passed
before submitting the prompt.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@ai/ai-prompt-template.md`:
- Around line 215-224: Add an explicit checklist item under the "Quick
Checklist" section to confirm markdown linting was executed: update the
checklist (the block beneath the "## Quick Checklist" header) to include a
checkbox like " - [ ] markdownlint-cli2 was run and all files pass" so reviewers
can verify that markdownlint-cli2 was run and passed before submitting the
prompt.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fa1151dd-1f7a-43c6-870a-51691655f607

📥 Commits

Reviewing files that changed from the base of the PR and between 1e54346 and 035cde4.

📒 Files selected for processing (1)

• ai/ai-prompt-template.md