Docs site 1/6: mdBook skeleton, quickstart, installation, glossary#47
Open
zklapow wants to merge 1 commit into
Open
Docs site 1/6: mdBook skeleton, quickstart, installation, glossary#47zklapow wants to merge 1 commit into
zklapow wants to merge 1 commit into
Conversation
zklapow
force-pushed
the
docs-site-skeleton
branch
from
06fd903 to
e8b8469
Compare
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.
First of a six-PR stack adding a proper documentation site (mdBook → GitHub Pages at https://github.hubspot.com/boomslang/). The repo's docs were a single README; key specs and guides had no home, and the quickstart didn't reflect what actually works.
This PR: the book skeleton (
docs/), an introduction, a quickstart verified end-to-end againstcom.hubspot:boomslang:0.1.1from Maven Central, an installation page covering theno-python-runtimeclassifier, and a glossary fixing the host/guest naming confusion. Addsmdbookto the Nix shell.Notable: the verified quickstart includes
.addExtension(HostBridge.builder().buildExtension())— the old README snippet failed instantiation (unknown import ... boomslang.log) because the bundled wasm unconditionally imports the host-bridge functions.Note: the Pages deploy workflow (
docs.yml) ships separately ondocs-ci-workflow— pushing workflow files needs aworkflow-scoped token.Stack: this PR → docs-user-guide → docs-reference → docs-contributing → docs-java-api → docs-rustdoc.