Repository navigation
Retire the classic Python CLI and launch a new docs site - #165
Merged
Merged
Conversation
Remove the spec-only classic CLI and REST API (src/) in favour of the OFFAT platform (map -> code graph -> test-gen -> Rust engine -> triage -> report). - delete src/ and the PyPI workflow that built it (its last release stays on PyPI) - dev/release image workflows build one platform image from docker/Dockerfile instead of the four classic images - action.yml runs the platform: source-only by default; a live run needs both `url` and `authorized: 'true'` (mirrors the CLI's --yes gate); optional SARIF upload to code scanning - Dockerfile/Makefile install the whitebox [graph] extra - README and OWASP project page lead with the platform BREAKING CHANGE: `pip install offat`, the `offat` CLI and `offat-api` are no longer built from this repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace Jekyll/just-the-docs with docs/build.py (Python-Markdown + Pygments) and a custom "signal trace" theme: - home page with hero, pipeline card, highlights and feature cards - three-column docs layout, sticky sidebar and on-this-page TOC with scroll spy, off-canvas navigation on mobile - light/dark themes (system default, persisted toggle), Cmd/Ctrl-K search over a generated index, code blocks with language labels and copy buttons, callouts, prev/next pager, edit-on-GitHub links, 404 page, sitemap - content rewritten for the platform: no classic-CLI sections; new Code graph page; design docs promoted to "Deep dives" and corrected (graft/semgrep era text, non-existent OFFAT_GB_* env vars) - Pages workflow builds with Python; CI builds the site on every PR Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
…ld.py Co-Authored-By: Claude Opus 5.5 <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
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
Two commits, on top of the merged #164.
1. Retire the classic Python CLI (
feat!)src/(the spec-onlyoffatCLI,offat-api, its Dockerfiles and compose file) andpypi-publish.yml, which built it. The lastoffatrelease stays on PyPI.dev-push.ymlandrelease-push.ymlnow build one platform image fromdocker/Dockerfileinstead of the four classic images.action.ymlruns the platform:urlandauthorized: 'true', mirroring the CLI's--yesgate;whitebox[graph]extra. The README and the OWASP project page now lead with the platform.Breaking:
pip install offat, theoffatCLI andoffat-apiare no longer built from this repo.2. New docs site
Jekyll/just-the-docs is replaced by
docs/build.py(Python-Markdown + Pygments) and a custom theme:/search over a generated index;OFFAT_GB_*environment variables that don't exist in the code.Test plan
python docs/build.pybuilds 12 pages; static checks found no broken internal links or anchors, well-formed HTML,app.jsparses, and no Jekyll or kramdown syntax leaks into the outputpython docs/build.py && python -m http.server -d docs/_site🤖 Generated with Claude Code