Conversation
- Training Materials: building reusable course content with includes - Engineering Handbook: automated internal docs that stay in sync - Release Notes Pipeline: validated release notes with executable examples - AI-Assisted Authoring: combining AI speed with build-time validation Partial progress on #3
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2b4bd2aaaf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <cmd exec="bash scripts/migrate.sh"></cmd> | ||
|
|
||
| If you see errors at Step 2, check the | ||
| [troubleshooting guide](/docs/troubleshooting/). |
There was a problem hiding this comment.
This link targets /docs/troubleshooting/, but a repo-wide search shows no matching page or slug (the only troubleshooting reference is this line), so the published link will 404. Readers who hit migration errors are sent to a dead end instead of actionable guidance.
Useful? React with 👍 / 👎.
| - name: Create GitHub Release | ||
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| body_path: releases/${{ github.ref_name }}/RELEASE.md |
There was a problem hiding this comment.
The workflow example uses ${{ github.ref_name }} instead of ${{ github.ref_name }} for body_path. In a fenced code block, readers will copy these entities literally, so GitHub Actions will not interpolate the ref name and the example path is incorrect for real workflows.
Useful? React with 👍 / 👎.
1 participant
Summary
Adds the remaining 4 tutorials from the usage scenario series (#3):
Training Materials — Building reusable course content with Hype's include system, snippets, and code execution. Covers modular structure, shared content, exercises, and multi-format output.
Engineering Handbook — Automating internal docs: coding standards with compiled examples, onboarding scripts that run in CI, runbooks with validated commands, and auto-updating API docs via
go doc.Release Notes Pipeline — Validated release notes with executable migration scripts, breaking change examples that show real compiler errors, dynamic version info, and CI integration for automated GitHub releases.
AI-Assisted Authoring — Combining AI coding assistants with Hype's build-time validation. Generate → build → fix workflow, practical walkthrough, tips for effective AI prompting, and output stabilization.
Combined with the existing posts (Single-Source Docs, Deploying with Docker), this completes the 6 flagship tutorials.
Partial progress on #3
Test plan
hype blog buildsucceeds (18 articles, no warnings)/blog/listing