docs: Fix typos across documentation and add CONTRIBUTING.md #85
+230
−34
Conversation
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
- Fix grammatical error 'between the every' to 'between every' on line 7 - Fix spacing issue 'theworkshop' to 'the workshop' on line 7 - Remove duplicate article 'The the BAML' to 'The BAML' on line 97 - Fix spelling error 'simpile' to 'simple' on line 145 - Update placeholder chapter number 'Chapter XX' to 'Chapter 12' on line 712
- Fix grammatical error 'between the every' to 'between every' in 6 files
- Fix spacing issue 'theworkshop' to 'the workshop' in 6 files
- Remove duplicate article 'The the BAML' to 'The BAML' in 6 files
- Fix spelling error 'simpile' to 'simple' in 6 files
- Update placeholder 'Chapter XX' to 'Chapter 12' in 4 files
Affected files:
- workshops/2025-05/walkthrough.md and walkthrough.yaml
- workshops/2025-05/sections/{00-hello-world,01-cli-and-agent,02-calculator-tools,12-humanlayer-webhook,final}/README.md
- workshops/2025-05-17/walkthrough.md and walkthrough.yaml
- workshops/2025-05-17/sections/{00-hello-world,01-cli-and-agent,02-calculator-tools}/README.md
- Fix typo 'inggest' to 'inngest' in README.md (line 94) - Fix typo 'libriaries' to 'libraries' in README.md (line 183) - Fix typo 'inggest' to 'inngest' in content/brief-history-of-software.md (line 22) - Add comprehensive CONTRIBUTING.md with guidelines for: - Reporting issues and suggesting enhancements - Documentation and code contributions - Development setup instructions - Pull request process and commit message format - Style guidelines for Markdown, TypeScript, and BAML
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
Comprehensive documentation improvements including typo fixes across the entire codebase and the addition of a CONTRIBUTING.md file.
Changes
Commit 1: Template README Fixes
Commit 2: Workshop Documentation Fixes (12 files)
Fixed the same systematic typos across workshop materials:
workshops/2025-05/walkthrough.mdand.yamlworkshops/2025-05/sections/{00-hello-world,01-cli-and-agent,02-calculator-tools,12-humanlayer-webhook,final}/README.mdworkshops/2025-05-17/walkthrough.mdand.yamlworkshops/2025-05-17/sections/{00-hello-world,01-cli-and-agent,02-calculator-tools}/README.mdCommit 3: Main README Fixes + CONTRIBUTING.md
Typo Fixes:
New File: CONTRIBUTING.md
A comprehensive contributing guide including:
Impact
Type of Change
Checklist