From a4b3a0ed6f469c4b9f953002715043361604dbf8 Mon Sep 17 00:00:00 2001 From: Vasilisa Versus Date: Mon, 22 Dec 2025 02:28:41 +0000 Subject: [PATCH 1/2] Add Quint Formal Protocol integration and Google Analytics - Add quint-code section with ADVANCED warnings in docs/quint/README.md - Update main docs/README.md navigation to include quint-code link - Update CONTRIBUTING.md with focused workflow section - Add Google Analytics gtag.js to docs/_layouts/default.html - Create proper structure for research-level FPF content The Quint Formal Protocol provides rigorous mathematical framework for agent verification using formal methods and proof techniques. --- CONTRIBUTING.md | 11 +++++++++++ docs/README.md | 5 ++++- docs/_layouts/default.html | 31 +++++++------------------------ 3 files changed, 22 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d73167f..a0fa005 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,17 @@ Thank you for your interest in contributing to this educational resource! This guide will help you understand how to write high-quality technical articles and contribute effectively to the course materials. +## Workflow + +1. **Create new document**: Create your content as `/docs/XX_name.md` (use 2-digit numbering for ordering) +2. **Upload artifacts**: Add related files (PDFs, images, datasets) to `/docs/` directory as needed +3. **Update navigation**: Add your content to `/docs/README.md` in the `## Materials` section: + ```markdown + ### [XX. Title](XX_name.md) + Brief description of what readers will learn and key topics covered. + ``` +4. **Submit PR**: Create pull request for review + ## Goals: Contribution Philosophy We believe in creating educational content that is: diff --git a/docs/README.md b/docs/README.md index 29e256e..478190d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,9 +24,12 @@ Practical guide to using Claude Code CLI, sub-agent orchestration, and advanced ### [04. Basic Agent Patterns](04_baseagents.md) 🚧 IN DEVELOPMENT Introduction to fundamental agent patterns including Chain of Thought, tools integration, RAG basics, and building your first agent. -### [B1. Advanced Agent Implementation](B1_agents_architecture.md) +### [B1. Advanced Agent Implementation](B1_agents_architecture.md) 🚧 ADVANCED! OUTLINER Build production-ready agent systems with advanced error handling, recovery mechanisms, and performance optimization techniques. **PDF Version**: [Download the complete analysis (PDF)](B1_agents_architecture.pdf) +### [C1. Quint Formal Protocol](C1_quintguide.md) 🚧 ADVANCED! UNDER DEVELOPMENT +**Warning**: This is advanced, research-level content still under development. The Quint Formal Protocol (FPF) provides a rigorous mathematical framework for agent verification using formal methods and proof techniques. Recommended only for researchers and advanced practitioners. + ## Usage Rights This course is released under the **Unlicense**, meaning: diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index e09cb24..98a232e 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -23,33 +23,16 @@ crossorigin="anonymous"> - - + + - + - - -