Repository navigation
Rebuild 0.3 documentation with integrated editable examples and versioned publishing - #25
Open
marcelMaier wants to merge 1 commit into
Open
marcelMaier wants to merge 1 commit into
marcelMaier wants to merge 1 commit into
Conversation
… Pages publishing
This branch has not been deployed
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.
The 0.3 documentation currently separates reference reading from trying examples. This rebuild gives guides, reference pages and the playground one progressively enhanced application, with a clear task-based entry path and editable JavaScript/TypeScript examples alongside PDF results.
Documentation and examples
llms.txt,llms-full.txtand search/discovery exports from the same source. Add a read-only stdio MCP documentation server with search and document resources.Runtime and release coordination
The default runtime remains pinned to published pdfmake 0.3.12. Unreleased native declarations and validation/diagnostic additions are explicitly labeled.
PDFMAKE_SOURCEcan select a locally built improved library; the preflight API is used only when the selected runtime actually implements it.A declaration-only, licensed snapshot keeps documentation type checking reproducible ahead of the matching library release. Synchronization and integrity checks cover that snapshot; real packed-package imports are tested in the companion library change. Runtime and type pins should be updated together when those additions are released.
GitHub Pages
Prepare explicit publication of the tested artifact through SHA-pinned official Pages actions and OIDC. PR checks retain read-only permissions. The production job is restricted to an explicit dispatch on the upstream master branch and uses the
github-pagesenvironment.The assembly step preserves the existing landing page and historical snapshots, verifies the current snapshot identity/runtime and places it under the correct project-Pages path. After successful deployment, the exact site is archived with a normal fast-forward push so later series preserve updated snapshots. Publications are serialized; archive pushes do not retrigger the docs workflow.
No deployment or repository-setting change has been performed. Before activation, maintainers need to select Actions as the Pages source, protect the deployment environment and retire any competing publisher. The historical
gh-pagesbranch remains the preservation archive.Validation
Locally verified on Windows with Node 24.15.0, Hugo 0.168.0 and Chrome:
Companion library pull request: bpampuch/pdfmake#2952