Skip to content

Improve Phase 11 LLM engineering documentation#202

Open
kuljeetsinhparmar wants to merge 2 commits into
rohitg00:mainfrom
kuljeetsinhparmar:main
Open

Improve Phase 11 LLM engineering documentation#202
kuljeetsinhparmar wants to merge 2 commits into
rohitg00:mainfrom
kuljeetsinhparmar:main

Conversation

@kuljeetsinhparmar
Copy link
Copy Markdown

@kuljeetsinhparmar kuljeetsinhparmar commented May 26, 2026

What this PR does

Improves the Phase 11 LLM Engineering documentation by adding beginner-friendly project ideas and common beginner mistakes related to LLM application development.

Kind of change

  • New lesson
  • Fix to an existing lesson
  • Translation
  • New output (prompt, skill, agent, MCP server)
  • Docs / website / tooling

Checklist

  • Code runs without errors with the listed dependencies
  • No comments in code files (docs explain, code is self-explanatory)
  • Built from scratch first, then shown with a framework (for new lessons)
  • Lesson folder matches LESSON_TEMPLATE.md structure
  • ROADMAP.md row for the lesson is a markdown link ([Name](phases/...)), not bare text
  • One lesson per commit (atomic per-lesson rule)
  • Tested locally / code output matches what docs/en.md claims

Phase / lesson

Phase 11 · LLM Engineering

Notes for reviewer

Added concise beginner-oriented documentation to improve learning clarity and provide practical project ideas for newcomers exploring LLM engineering concepts.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d46bca13-6a95-4a48-99d2-d0dda61bb41d

📥 Commits

Reviewing files that changed from the base of the PR and between fc44bc9 and 9980d17.

📒 Files selected for processing (1)
  • .gitignore
✅ Files skipped from review due to trivial changes (1)
  • .gitignore

📝 Walkthrough

Walkthrough

Phase 11 README content is expanded from a brief production tagline to a comprehensive overview of LLM app building, adding beginner project ideas and common mistakes. The .gitignore is updated to exclude the .history/ IDE directory.

Changes

Phase 11 Documentation Updates

Layer / File(s) Summary
Phase 11 README content expansion
phases/11-llm-engineering/README.md
Phase 11 README replaces the original brief tagline with an expanded introduction describing production-ready LLM app building and practical concepts (prompt engineering, RAG/vector databases, evaluation, agents, deployment). New beginner-focused sections list recommended project ideas and common beginner mistakes.

Repository Configuration

Layer / File(s) Summary
Gitignore IDE history exclusion
.gitignore
.history/ directory is added to .gitignore to exclude IDE-generated local file change history from version control.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: improving Phase 11 LLM engineering documentation by adding beginner-friendly content and project ideas.
Description check ✅ Passed The description is directly related to the changeset, clearly explaining the improvements made to Phase 11 documentation and providing context about beginner-oriented additions.
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

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.

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.

🧹 Nitpick comments (1)
.history/phases/11-llm-engineering/README_20260526200847.md (1)

1-6: ⚡ Quick win

Drop editor history snapshots from versioned docs.

This looks like a local history artifact and should not be committed in the main docs change set; it adds noise and duplicate content.

🤖 Prompt for 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.

In @.history/phases/11-llm-engineering/README_20260526200847.md around lines 1 -
6, The file README_20260526200847.md is an editor history snapshot and should be
removed from the docs commit: delete this snapshot file from the change set,
ensure the canonical phase README (e.g., README.md for phase 11) contains the
intended content if needed, and add or update .gitignore (or your repo cleanup
script) to exclude .history editor snapshots so future commits don’t include
files like README_20260526200847.md.
🤖 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.

Nitpick comments:
In @.history/phases/11-llm-engineering/README_20260526200847.md:
- Around line 1-6: The file README_20260526200847.md is an editor history
snapshot and should be removed from the docs commit: delete this snapshot file
from the change set, ensure the canonical phase README (e.g., README.md for
phase 11) contains the intended content if needed, and add or update .gitignore
(or your repo cleanup script) to exclude .history editor snapshots so future
commits don’t include files like README_20260526200847.md.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c06299a5-8523-491d-912b-1b86a1ef1cbe

📥 Commits

Reviewing files that changed from the base of the PR and between c1374e1 and fc44bc9.

📒 Files selected for processing (3)
  • .history/phases/11-llm-engineering/README_20260526200847.md
  • .history/phases/11-llm-engineering/README_20260526201247.md
  • phases/11-llm-engineering/README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant