Conversation
Add reference materials and improve navigation: - Create glossary.md with 30+ key term definitions - Create quick-reference.md with formulas and decision trees - Create how-to-use.md with reading paths and time estimates - Create exercises.md with 15+ hands-on exercises Improve structure and consistency: - Add Chapter 7 to Introduction roadmap (was orphaned) - Standardize frontmatter (authors array) in chapters 3.1, 3.2 - Expand multi-part chapter references in Introduction - Add navigation footers to chapters - Update mkdocs.yml with new reference section Enhance content: - Add case study summary tables to chapters 0, 1, 7 - Link workshop chapters to WildChat case study - Add "Chapter at a Glance" boxes to key chapters - Fix code block formatting issues - Add exercises links from chapters
|
Review these changes at https://app.gitnotebooks.com/567-labs/systematically-improving-rag/pull/65 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR makes comprehensive improvements to the ebook (workshops section) based on the quality review. The changes focus on improving navigation, adding reference materials, and enhancing content consistency.
New Reference Materials
glossary.md) - 30+ key term definitions with cross-references to chaptersquick-reference.md) - Formulas, decision trees, and checklists for quick lookuphow-to-use.md) - Reading paths, prerequisites, and time estimatesexercises.md) - 15+ hands-on exercises with step-by-step instructionsStructural Improvements
author:vsauthors:inconsistency)Content Enhancements
Test plan