Skip to content

docs(quickstart): add echo and document tree - #116

Merged
corylanou merged 1 commit into
mainfrom
issue-114-hype-preview-depends-on-tree
Sep 30, 2026
Merged

corylanou merged 1 commit into
mainfrom
issue-114-hype-preview-depends-on-tree

Conversation

@corylanou

@corylanou corylanou commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Summary

Document command prerequisites while keeping the directory listings as live, executed examples. The quickstart starts with a simple echo greeting, then introduces tree as an advanced example with an explicit installation requirement.

Related Issue

Closes #114

Changes

  • Add fenced source and live output for echo Hello from Hype, without replacement attributes.
  • Keep fenced source and live output for the advanced tree example, with a note that command executables must be installed on the machine building the docs.
  • Retain the live documentation directory listing and corrected README/documentation source links, with the same requirement note.
  • List Go and tree as documentation-build prerequisites.
  • Verify plain Markdown preview works with an empty command path and missing executables return a clear error.
  • Regenerate the README with the locally built exporter.

Test Plan

  • Tests pass (Go 1.25.0; the repository's race-enabled test package set, equivalent to make test).
  • Manually tested with hype documents: the local exporter executes the greeting and both directory listings when generating the README.
  • Documentation updated.
  • Full staticcheck passes with GOTOOLCHAIN=go1.25.0.

Breaking Changes

None

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-30T20:01:46.400591Z d44bf42 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@corylanou
corylanou force-pushed the issue-114-hype-preview-depends-on-tree branch from d44bf42 to 97a4c40 Compare September 30, 2026 21:01
Add a simple command example and retain live directory listings.
Document command installation and documentation-build prerequisites.
Verify plain preview needs no external commands and missing commands
produce clear errors.

Closes #114
@corylanou corylanou changed the title fix(docs): remove tree from bundled examples docs(quickstart): add echo and document tree Sep 30, 2026
@corylanou
corylanou force-pushed the issue-114-hype-preview-depends-on-tree branch from 97a4c40 to 9cdb58e Compare September 30, 2026 21:13
@corylanou
corylanou merged commit 79c0476 into main Sep 30, 2026
3 checks passed
@corylanou
corylanou deleted the issue-114-hype-preview-depends-on-tree branch September 30, 2026 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

hype preview depends on tree

1 participant