docs: documentation overhaul - archive, user guides, env parity (#62)
Some checks failed
CI / build (push) Has been cancelled

* docs: archive CLI runner scripts and Windows Docker guide, update web runner scripts

* docs: overhaul README and DOCKER.md, add 10 user guides

- README: Budget Mode section, corrected Further Reading links, theme badge descriptions, diagnostics expansion
- DOCKER.md: Windows path note, Budget Mode + Include/Exclude sections, env table additions
- docs/user_guides/: 10 new feature guides covering budget mode, include/exclude, locks/replace/permalinks, batch build, theme browser, random build, owned cards, partner mechanics, bracket compliance, quick build & skip controls

* fix: map PriceTimeoutError→503, add budget exceptions to status map; update error_handling.md

* docs: env var parity — add missing vars to .env.example and README table
This commit is contained in:
mwisnowski 2026-03-23 22:00:50 -07:00 committed by GitHub
parent 537f5d3834
commit ac6c9f4daa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 1074 additions and 23 deletions

View file

@ -1,6 +1,11 @@
@echo off
setlocal ENABLEDELAYEDEXPANSION
REM Primary entry point for the MTG Python Deckbuilder Web UI from Docker Hub.
REM Override any flag by setting it as an environment variable before running:
REM set THEME=light
REM set ENABLE_BUDGET_MODE=0
echo MTG Python Deckbuilder - Web UI (Docker Hub)
echo ============================================
@ -11,22 +16,45 @@ if not exist "csv_files" mkdir csv_files
if not exist "config" mkdir config
if not exist "owned_cards" mkdir owned_cards
REM Flags (override by setting env vars before running)
REM --- Core UI flags ---
if "%SHOW_LOGS%"=="" set SHOW_LOGS=1
if "%SHOW_DIAGNOSTICS%"=="" set SHOW_DIAGNOSTICS=1
if "%WEB_VIRTUALIZE%"=="" set WEB_VIRTUALIZE=0
if "%WEB_VIRTUALIZE%"=="" set WEB_VIRTUALIZE=1
REM --- Theming (system|light|dark) ---
if "%ENABLE_THEMES%"=="" set ENABLE_THEMES=1
if "%THEME%"=="" set THEME=dark
REM --- Budget Mode ---
if "%ENABLE_BUDGET_MODE%"=="" set ENABLE_BUDGET_MODE=1
if "%PRICE_LAZY_REFRESH%"=="" set PRICE_LAZY_REFRESH=1
REM --- Builder features ---
if "%ENABLE_BATCH_BUILD%"=="" set ENABLE_BATCH_BUILD=1
if "%WEB_STAGE_ORDER%"=="" set WEB_STAGE_ORDER=new
if "%WEB_IDEALS_UI%"=="" set WEB_IDEALS_UI=slider
if "%ALLOW_MUST_HAVES%"=="" set ALLOW_MUST_HAVES=1
if "%ENABLE_PARTNER_MECHANICS%"=="" set ENABLE_PARTNER_MECHANICS=1
REM --- Theme catalog badges ---
if "%SHOW_THEME_QUALITY_BADGES%"=="" set SHOW_THEME_QUALITY_BADGES=1
if "%SHOW_THEME_POOL_BADGES%"=="" set SHOW_THEME_POOL_BADGES=1
if "%SHOW_THEME_POPULARITY_BADGES%"=="" set SHOW_THEME_POPULARITY_BADGES=1
if "%SHOW_THEME_FILTERS%"=="" set SHOW_THEME_FILTERS=1
echo Starting Web UI on http://localhost:8080
echo Flags: SHOW_LOGS=%SHOW_LOGS% SHOW_DIAGNOSTICS=%SHOW_DIAGNOSTICS% WEB_VIRTUALIZE=%WEB_VIRTUALIZE% THEME=%THEME% ENABLE_THEMES=%ENABLE_THEMES%
REM Optional theme flags (set before running):
REM set THEME=system|light|dark
REM set ENABLE_THEMES=1
echo Flags: SHOW_LOGS=%SHOW_LOGS% SHOW_DIAGNOSTICS=%SHOW_DIAGNOSTICS% WEB_VIRTUALIZE=%WEB_VIRTUALIZE% THEME=%THEME%
echo ENABLE_BUDGET_MODE=%ENABLE_BUDGET_MODE% ENABLE_BATCH_BUILD=%ENABLE_BATCH_BUILD% WEB_STAGE_ORDER=%WEB_STAGE_ORDER%
docker run --rm ^
-p 8080:8080 ^
-e SHOW_LOGS=%SHOW_LOGS% -e SHOW_DIAGNOSTICS=%SHOW_DIAGNOSTICS% -e WEB_VIRTUALIZE=%WEB_VIRTUALIZE% ^
-e THEME=%THEME% -e ENABLE_THEMES=%ENABLE_THEMES% ^
-e ENABLE_THEMES=%ENABLE_THEMES% -e THEME=%THEME% ^
-e ENABLE_BUDGET_MODE=%ENABLE_BUDGET_MODE% -e PRICE_LAZY_REFRESH=%PRICE_LAZY_REFRESH% ^
-e ENABLE_BATCH_BUILD=%ENABLE_BATCH_BUILD% -e WEB_STAGE_ORDER=%WEB_STAGE_ORDER% -e WEB_IDEALS_UI=%WEB_IDEALS_UI% ^
-e ALLOW_MUST_HAVES=%ALLOW_MUST_HAVES% -e ENABLE_PARTNER_MECHANICS=%ENABLE_PARTNER_MECHANICS% ^
-e SHOW_THEME_QUALITY_BADGES=%SHOW_THEME_QUALITY_BADGES% -e SHOW_THEME_POOL_BADGES=%SHOW_THEME_POOL_BADGES% ^
-e SHOW_THEME_POPULARITY_BADGES=%SHOW_THEME_POPULARITY_BADGES% -e SHOW_THEME_FILTERS=%SHOW_THEME_FILTERS% ^
-v "%cd%\deck_files:/app/deck_files" ^
-v "%cd%\logs:/app/logs" ^
-v "%cd%\csv_files:/app/csv_files" ^
@ -37,5 +65,8 @@ docker run --rm ^
echo.
echo Open: http://localhost:8080
echo Tip: set SHOW_LOGS=0 or SHOW_DIAGNOSTICS=0 before running to hide those pages.
echo Tips:
echo set THEME=light^|dark^|system before running to change the theme
echo set ENABLE_BUDGET_MODE=0 to disable budget controls
echo set SHOW_LOGS=0 or SHOW_DIAGNOSTICS=0 to hide those pages
endlocal