.docs-test.toml

# Configuration for the docs-theme-extras harness when run against agw-oss.
#
# The harness lives in github.com/solo-io/docs-theme-extras and reads this
# file via the DOCS_TEST_CONFIG env var (set by the Makefile or CI). All
# relative paths are resolved against this file's directory.
#
# First-pass config: covers structural HTML quality (no shortcode leaks,
# no markdown bleed, image alt text, etc.) against the production build.
# Tighten or expand as the suite stabilizes.

version = "1"
name    = "agw-oss"
brand   = "oss"

# Where the consumer's built HTML lives. Everything operates on this tree.
# The harness does NOT build the site — `make build` (Hugo) runs first
# and writes here.
builtRoot = "./public"
baseURL   = "/"

# Hugo build log for hugo-warnings.spec. The Makefile targets and the CI build
# step write the Hugo build output here; the spec scans it for ERROR / WARN
# lines (filtered by [allowlists].hugoWarnings).
buildLog  = "./.build.log"

# Source-tree roots for author-side lints (curl-quotes scans markdown
# directly). Narrowed to docs content so the lint doesn't trip on blog
# posts and marketing copy that follow looser conventions.
scanRoots = [
  "./content/docs",
]

# URL versioning. agw-oss versions Kubernetes docs at
# /docs/kubernetes/<version>/...; standalone docs are unversioned and
# the spec gracefully skips pages that don't match.
[versioning]
versionFromPath = "^/docs/kubernetes/(?<version>[^/]+)/"
versions        = ["main", "latest", "2.2.x", "1.0.x"]

# All checks default to enabled. No [checks] overrides are needed: agw-oss
# runs the full default set. (The former `smoke`/`crossBrowser` toggles were
# removed from the harness — smoke folded into the `content` project scoped by
# CONTENT_DIR, and cross-browser is now selected per Playwright project.)

# Allowlists for known-benign noise that surfaces against real product
# content (test fixture has none of this). Tighten as content is fixed.
[allowlists]
hugoWarnings = [
  "\\.Site\\.Data was deprecated",
  "'items' parameter of the 'tabs' shortcode is deprecated",
  # FlexSearch bundle couldn't be fetched from the CDN at build time, so the
  # theme fell back to a runtime CDN <script> tag instead of failing the build.
  # This is a transient, network-only CI failure we don't control; the fallback
  # keeps the site working. The warnf is allowlisted so a blip doesn't turn CI
  # red, but it stays in the build log as a trace.
  "FlexSearch: could not fetch .* at build time",
]

# NOTE: agw-oss previously allowlisted two Hextra main.min.js null-dereferences
# (reading 'removeAttribute' / 'addEventListener') caused by its custom navbar
# omitting Hextra's toggle markup. Those are now FIXED at the source: hidden
# stand-in elements (.hextra-hamburger-menu wrapping an <svg>, and
# .hextra-sidebar-container) render on every page via custom/footer.html, so
# main.js no longer null-derefs. The allowlist entries were removed so this
# console guard is re-armed — if the stand-ins regress, the error surfaces here
# (and in the static "Hextra hamburger toggle target" guard in docs-theme-extras).
consoleErrors = [
  # Chatbot widget makes a backend API call on every page initialization;
  # the call fails in the test environment and surfaces as a bare pageerror
  # with no stack ("pageerror: invalid_request"). Not fixable without a live
  # backend — suppress until the chatbot is refactored to not throw on init.
  "invalid_request",
  # hero-background.svg is referenced by the blog templates but the file is
  # missing from the source tree. Browsers log the 404 as a console.error.
  # Track as a bug to restore the asset; suppress here until that is fixed.
  "hero-background\\.svg",
]