Documentation Tools
Canonical screenshot route manifest, safe capture policy, and documentation tooling for the UEC knowledge bundle.
Route manifest
Section titled “Route manifest”uec-routes.tsv is the console capture manifest. Each line is:
slug|/console/pathThe slug is also the basename of the light and dark screenshot in images/{light,dark}/pages/.
Only canonical destinations belong in this manifest. Do not add legacy alias pages that immediately redirect; document the canonical target instead. This avoids redirect loops and duplicate screenshots.
Rate-limit and redirect policy
Section titled “Rate-limit and redirect policy”- Use one
agent-browsersession and one tab. - Sign in once; if a page unexpectedly returns to login, stop and investigate instead of signing in again.
- Keep a 15-second gap after navigation.
- Never capture parallel route batches against the same tenant.
- Record only canonical destinations; aliases and query-string duplicates add server traffic without adding evidence.
Refresh script
Section titled “Refresh script”refresh-screenshots.sh performs the same one-tab, one-session, 15-second capture used for this guide:
export UEC_URL="https://platform.example.com/xdr/uec/default"export UEC_USERNAME="you@example.local"export UEC_PASSWORD="..."./tools/refresh-screenshots.shThe script captures or refreshes the signed-out login page, signs in once, captures every canonical page, prints no credential, switches themes through the real console control, and fails if a page lacks the expected opposite theme switch or unexpectedly lands back on login.
OKF builder
Section titled “OKF builder”build_okf.py normalizes this repository as an OKF v0.2 bundle:
python3 tools/build_okf.pyIt adds concept frontmatter and provenance, converts concept links to bundle-relative paths, generates index.md files for progressive disclosure, and refreshes the root update log.
Browser documentation site
Section titled “Browser documentation site”The canonical OKF Markdown is prepared for Astro Starlight with:
npm run docs:buildnpm run docs:previewtools/prepare_starlight.py generates src/content/docs/, copies images to public/images/, and creates the sidebar. The generated browser tree is intentionally ignored; the OKF Markdown remains the source of truth.
Screenshot rules
Section titled “Screenshot rules”- Sign in to the target environment with
UEC_USERNAMEandUEC_PASSWORD; do not put credentials in documentation, scripts or command history. - Use a 1600×1000 viewport.
- Capture every route in both themes.
- Wait 15 seconds after each navigation; AMTD pass-through views especially need time to finish loading upstream data.
- On that loaded page, activate the real light/dark switch, verify the opposite switch label, and save both themes. This proves the theme alignment without loading the page twice.
- Update
tools/uec-routes.tsvandreference/screenshot-catalogue.mdwhen a route changes. - Regenerate OKF metadata and indexes with
python3 tools/build_okf.py. - Run both validation suites before committing:
python3 tests/test_documentation_structure.py && python3 tests/test_okf_conformance.py.