Docs: restore curriculum nav, add coaching blocks, and ASCII lint CI#14
Merged
bryanchriswhite merged 11 commits intomainfrom Jan 30, 2026
Merged
Docs: restore curriculum nav, add coaching blocks, and ASCII lint CI#14bryanchriswhite merged 11 commits intomainfrom
bryanchriswhite merged 11 commits intomainfrom
Conversation
Adds a workflow that runs on PRs touching doc directories, scripts, or package files. Executes npm run lint:ascii and npm test in a single job on ubuntu-latest with Node 20.
…idebar Reduce sidebar clutter by collapsing curriculum part subcategories and examples by default, while expanding mental models and community sections.
Add root package.json with lint:ascii, format:ascii, and test scripts, along with the format-ascii tooling, TypeScript config, and vitest setup.
Remove package-lock.json from .gitignore so CI can use npm ci.
Contributor
Author
|
@greptile |
bryanchriswhite
commented
Jan 30, 2026
Comment on lines
157
to
+160
| │ ├── 00-hello-world-console/ # Simplest possible program | ||
| │ ├── 01-chat-cli/ # Stage 1: Terminal app | ||
| │ ├── 02-chat-static-web/ # Stage 2: HTML/CSS/JS | ||
| │ └── 03-chat-cli-typescript/ # Stage 1 with types | ||
| │ ├── 11-chat-cli/ # Stage 1: Terminal app | ||
| │ ├── 12-chat-static-web/ # Stage 2: HTML/CSS/JS | ||
| │ └── 13-chat-cli-typescript/ # Stage 1 with types |
Contributor
Author
There was a problem hiding this comment.
I'm confused about this change - it seems like we would be going from 00, 11, 12, 13, which doesn't make sense. What's the rationale here?
Greptile OverviewGreptile SummaryThis PR reorganizes the documentation structure and adds automated tooling for ASCII diagram formatting. The changes restore curriculum parts II–IV in the sidebar, add coaching prompts throughout documentation to encourage better question-asking when using AI tools, and establish a CI pipeline for maintaining ASCII diagram consistency. Key changes:
The implementation is well-structured with proper TypeScript configuration, comprehensive test coverage, and thoughtful handling of edge cases like nested boxes (left unchanged with warnings rather than mangled). Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant GH as GitHub
participant CI as CI Workflow
participant Linter as ASCII Linter
participant Tests as Vitest
Dev->>GH: Push changes to PR
GH->>CI: Trigger lint-ascii workflow
CI->>CI: Checkout code
CI->>CI: Setup Node.js 20
CI->>CI: npm ci (install dependencies)
CI->>Linter: npm run lint:ascii
Linter->>Linter: Find markdown files
Linter->>Linter: Detect ASCII boxes in fenced blocks
Linter->>Linter: Check if boxes are formatted
alt Formatting issues found
Linter->>CI: Exit 1 (formatting drift)
CI->>GH: ❌ Check failed
else No formatting issues
Linter->>CI: Exit 0 (all formatted)
CI->>Tests: npm test
Tests->>Tests: Run vitest suite
Tests->>Tests: Test box detection & formatting
alt Tests fail
Tests->>CI: Exit 1
CI->>GH: ❌ Check failed
else Tests pass
Tests->>CI: Exit 0
CI->>GH: ✅ Check passed
end
end
|
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
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
##Testing
##Notes