docs: add ARO Essential Primer with PDF build and CI/CD integration#252
Merged
docs: add ARO Essential Primer with PDF build and CI/CD integration#252
Conversation
Adds a new ~10-page technical introduction to ARO covering language fundamentals, internal architecture, compilation pipeline, plugin system, and domain analysis. Includes a local build script and integrates the PDF into both GitHub Actions and GitLab CI documentation/release pipelines so it is produced as a build artifact and attached to every tagged release.
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.
Summary
Book/TheEssentialPrimer/TheEssentialPrimer.md— a ~10-page technical introduction to ARO covering language fundamentals, internal architecture (compilation pipeline, execution engine, event bus, semantic roles), native compilation, plugin system, and honest domain analysisBook/TheEssentialPrimer/build-pdf.sh+metadata.yaml— local PDF build script following the same pattern asTheShortStudies; producesARO-Essential-Primer.pdfvia WeasyPrint (primary) or xelatex (fallback)documentationjob: build step + artifact upload (30-day retention)releasejob: PDF included in release assets and documentation table in release bodydocumentationjob: build step + artifact pathreleasejob: artifact path, release description table row, and asset linkBook/TheEssentialPrimer/outputto.gitignore(consistent with all other book output directories)Test plan
documentationjob passes on CI andARO-Essential-Primer.pdfis downloadable as a build artifactARO-Essential-Primer.pdfappears as an asset on the GitHub Releases pageARO-Essential-Primer.pdfappears as a linked asset on the GitLab Releases pagecd Book/TheEssentialPrimer && ./build-pdf.shproducesoutput/ARO-Essential-Primer.pdf