docs: GitHub Pages tutorial site (Tutorial/) — EN + 中文#15
Merged
Conversation
A static, no-build documentation site under Tutorial/ that covers AppleTrace end to end — introduction, quick start, installation, manual / Swift / objc_msgSend tutorials, event types, the Perfetto workflow, the demo apps, environment variables, platform support, and an FAQ. English is primary (index.html), Chinese secondary (zh.html), with an EN/中文 toggle. Design: a dark "trace-viewer" theme echoing a Perfetto timeline (teal brand accent, animated track-lane hero motif), distinctive type (Bricolage Grotesque + IBM Plex Sans/Mono), sticky sidebar nav with scroll-spy, copy buttons, and a mobile menu. Plain HTML/CSS + progressive-enhancement JS, so GitHub Pages serves it with no build step (.nojekyll). .github/workflows/pages.yml deploys Tutorial/ to Pages on pushes to master. One-time setup: Settings ▸ Pages ▸ Source = "GitHub Actions". README / README_CN link to the published guide. Both pages validated (balanced markup) and rendered (headless Chrome) in English and Chinese. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
What
A static, no-build GitHub Pages site under
Tutorial/— a comprehensive usage guide for AppleTrace, English primary (index.html) and Chinese secondary (zh.html) with an EN/中文 toggle.Covered end to end: Introduction · Quick Start · Installation (SwiftPM + framework) · Manual instrumentation (ObjC/C/C++) · Tracing Swift (macros +
AppleTraceAuto) ·objc_msgSendhook · Event types · Visualizing in Perfetto · Demo apps · Environment variables · Platform support · FAQ/troubleshooting.Design
A dark trace-viewer theme that echoes a Perfetto timeline — teal brand accent (
#4ECDC4), an animated track-lane hero motif, distinctive type (Bricolage Grotesque + IBM Plex Sans/Mono), sticky sidebar nav with scroll-spy, copy-to-clipboard on code blocks, and a mobile menu. Plain HTML/CSS + progressive-enhancement JS;.nojekyllso Pages serves it verbatim.Deploy
.github/workflows/pages.ymlpublishesTutorial/to Pages on pushes tomaster.Tutorial/**change) deploys tohttps://everettjf.github.io/AppleTrace/. README / README_CN already link there.Verification
libarclite/ rpath /-sdkgotchas).🤖 Generated with Claude Code