Skip to content

docs: publish a concise Bessemer interface - #60

Open
Windsor Nguyễn (windsornguyen) wants to merge 1 commit into
feat/progressive-clifrom
docs/beginner-interface
Open

docs: publish a concise Bessemer interface#60
Windsor Nguyễn (windsornguyen) wants to merge 1 commit into
feat/progressive-clifrom
docs/beginner-interface

Conversation

@windsornguyen

@windsornguyen Windsor Nguyễn (windsornguyen) commented Aug 12, 2026

Copy link
Copy Markdown
Member

Depends on #59.

What does this change?

This PR documents the public Bessemer interface.

  • The README starts with the supported product contract and the init, build, and clean workflow.
  • NOTICE and UPSTREAM_CHANGELOG.md contain Buck2 provenance.
  • The MkDocs site documents the quick start, TypeScript, Rust, support status, configuration, and generated CLI reference.
  • The site excludes inherited pages that have not been verified against the native Bessemer model.
  • A typed Hollywood workflow builds documentation for trusted changes.
  • The workflow deploys GitHub Pages only from main.

How was it tested?

  • pnpm run ci check.

  • python -m mkdocs build --strict -f mkdocs.yml.

  • pnpm run ci check validates the generated workflow and its security policy.

  • pnpm run ci check license validates repository license and provenance policy.

  • CLA/Vouch check passes, or this PR only updates VOUCHED.td.

@socket-security

socket-security Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addedpypi/​pymdown-extensions@​11.0.19910010010080
Addedpypi/​mkdocs-material@​9.7.790100100100100
Addedpypi/​mkdocs@​1.6.192100100100100
Addedpypi/​mkdocs-llmstxt@​0.5.0100100100100100
Addedpypi/​mkdocs-llmstxt-md@​0.3.0100100100100100

View full report

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.

2 participants