Skip to content

Commit c3e2e4a

Browse files
authored
Merge pull request #145 from johnxie/pr/tutorial-depth-batch-2
docs: deepen tutorial chapters batch 2 (copilot-cli through llama-factory)
2 parents 93d1dbe + 207743f commit c3e2e4a

370 files changed

Lines changed: 105666 additions & 87 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

tutorials/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,16 @@ Use this guide to navigate all tutorial tracks, understand structure rules, and
1717
<<<<<<< HEAD
1818
| Tutorial directories | 188 |
1919
| Tutorial markdown files | 1705 |
20-
| Tutorial markdown lines | 632,794 |
20+
| Tutorial markdown lines | 738,367 |
2121
=======
22+
<<<<<<< HEAD
2223
| Tutorial directories | 188 |
2324
| Tutorial markdown files | 1705 |
24-
| Tutorial markdown lines | 632,794 |
25+
| Tutorial markdown lines | 738,367 |
26+
=======
27+
| Tutorial directories | 188 |
28+
| Tutorial markdown files | 1705 |
29+
| Tutorial markdown lines | 738,367 |
2530

2631
## Source Verification Snapshot
2732

@@ -38,6 +43,7 @@ Repository-source verification run against tutorial index references (GitHub API
3843
- JSON: [../discoverability/tutorial-source-verification.json](../discoverability/tutorial-source-verification.json)
3944
- Script: [../scripts/verify_tutorial_sources.py](../scripts/verify_tutorial_sources.py)
4045
>>>>>>> origin/main
46+
>>>>>>> origin/main
4147
4248
## Content Structure Patterns
4349

tutorials/copilot-cli-tutorial/01-getting-started.md

Lines changed: 601 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/02-authentication-and-access-policies.md

Lines changed: 610 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/03-interactive-workflow-and-approval-model.md

Lines changed: 610 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/04-models-experimental-features-and-autopilot.md

Lines changed: 598 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/05-mcp-and-lsp-extension-points.md

Lines changed: 610 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/06-github-native-context-workflows.md

Lines changed: 610 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/07-installation-and-update-channels.md

Lines changed: 598 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilot-cli-tutorial/08-production-governance-and-team-rollout.md

Lines changed: 609 additions & 0 deletions
Large diffs are not rendered by default.

tutorials/copilotkit-tutorial/01-getting-started.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ parent: CopilotKit Tutorial
88

99
# Chapter 1: Getting Started with CopilotKit
1010

11+
Welcome to **Chapter 1: Getting Started with CopilotKit**. In this part of **CopilotKit Tutorial: Building AI Copilots for React Applications**, you will build an intuitive mental model first, then move into concrete implementation details and practical production tradeoffs.
12+
13+
1114
> Set up CopilotKit in your React application and create your first AI copilot with basic functionality.
1215
1316
## Overview
@@ -653,4 +656,51 @@ Now that you have a basic copilot running, let's explore how to make your app co
653656

654657
**Ready for Chapter 2?** [Reading App Context](02-app-context.md)
655658

656-
*Generated for [Awesome Code Docs](https://github.com/johnxie/awesome-code-docs)*
659+
*Generated for [Awesome Code Docs](https://github.com/johnxie/awesome-code-docs)*
660+
661+
## What Problem Does This Solve?
662+
663+
Most teams struggle here because the hard part is not writing more code, but deciding clear boundaries for `text`, `className`, `todo` so behavior stays predictable as complexity grows.
664+
665+
In practical terms, this chapter helps you avoid three common failures:
666+
667+
- coupling core logic too tightly to one implementation path
668+
- missing the handoff boundaries between setup, execution, and validation
669+
- shipping changes without clear rollback or observability strategy
670+
671+
After working through this chapter, you should be able to reason about `Chapter 1: Getting Started with CopilotKit` as an operating subsystem inside **CopilotKit Tutorial: Building AI Copilots for React Applications**, with explicit contracts for inputs, state transitions, and outputs.
672+
673+
Use the implementation notes around `copilotkit`, `react`, `note` as your checklist when adapting these patterns to your own repository.
674+
675+
## How it Works Under the Hood
676+
677+
Under the hood, `Chapter 1: Getting Started with CopilotKit` usually follows a repeatable control path:
678+
679+
1. **Context bootstrap**: initialize runtime config and prerequisites for `text`.
680+
2. **Input normalization**: shape incoming data so `className` receives stable contracts.
681+
3. **Core execution**: run the main logic branch and propagate intermediate state through `todo`.
682+
4. **Policy and safety checks**: enforce limits, auth scopes, and failure boundaries.
683+
5. **Output composition**: return canonical result payloads for downstream consumers.
684+
6. **Operational telemetry**: emit logs/metrics needed for debugging and performance tuning.
685+
686+
When debugging, walk this sequence in order and confirm each stage has explicit success/failure conditions.
687+
688+
## Source Walkthrough
689+
690+
Use the following upstream sources to verify implementation details while reading this chapter:
691+
692+
- [View Repo](https://github.com/CopilotKit/CopilotKit)
693+
Why it matters: authoritative reference on `View Repo` (github.com).
694+
- [Awesome Code Docs](https://github.com/johnxie/awesome-code-docs)
695+
Why it matters: authoritative reference on `Awesome Code Docs` (github.com).
696+
697+
Suggested trace strategy:
698+
- search upstream code for `text` and `className` to map concrete implementation paths
699+
- compare docs claims against actual runtime/config code before reusing patterns in production
700+
701+
## Chapter Connections
702+
703+
- [Tutorial Index](index.md)
704+
- [Next Chapter: Chapter 2: Reading App Context - Making Your App State Visible to AI](02-app-context.md)
705+
- [Main Catalog](../../README.md#-tutorial-catalog)
706+
- [A-Z Tutorial Directory](../../discoverability/tutorial-directory.md)

0 commit comments

Comments
 (0)