m0rph3us1987/HIPCTF2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation to OKF v0.1 format

Browse Source
This commit is contained in:
OpenVelo Agent
2026-07-21 16:11:03 +00:00
parent 6feaf08bdb
commit 8a573f9306
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guides/bootstrap.md
+4 -3
View File
@@ -3,7 +3,7 @@ type: guide
title: First-Run Bootstrap title: First-Run Bootstrap
description: How a fresh HIPCTF instance is initialized by the very first administrator. description: How a fresh HIPCTF instance is initialized by the very first administrator.
tags: [guide, bootstrap, first-admin, onboarding, tester] tags: [guide, bootstrap, first-admin, onboarding, tester]
timestamp: 2026-07-21T15:05:00Z timestamp: 2026-07-21T16:09:53Z
--- ---
# When this flow runs # When this flow runs
@@ -40,7 +40,8 @@ bypassed.
- **Confirm Password** — must equal the password above (verified by - **Confirm Password** — must equal the password above (verified by
the group-level `passwordMatchValidator`; mismatch shows the group-level `passwordMatchValidator`; mismatch shows
`data-testid="setup-confirm-error"`). `data-testid="setup-confirm-error"`).
5. Click **Create admin** (`data-testid="setup-submit"`). 5. Click **Create admin** (`data-testid="setup-submit"`). The button remains enabled while the form is invalid so this validation flow can be triggered; it is disabled only while a submission is in progress.
6. To verify client-side validation, submit with empty or partial fields. The overlay stays open, the relevant field errors appear, and no administrator is created or setup request is sent.
# Expected behavior # Expected behavior
@@ -69,7 +70,7 @@ The modal **cannot** be dismissed by the user:
| Username input | `[data-testid="setup-username"]` | Reactive control with length/pattern rules. | | Username input | `[data-testid="setup-username"]` | Reactive control with length/pattern rules. |
| Password input | `[data-testid="setup-password"]` | Reactive control. | | Password input | `[data-testid="setup-password"]` | Reactive control. |
| Confirm input | `[data-testid="setup-password-confirm"]` | Reactive control. | | Confirm input | `[data-testid="setup-password-confirm"]` | Reactive control. |
| Submit button | `[data-testid="setup-submit"]` | Disabled while submitting or invalid. | | Submit button | `[data-testid="setup-submit"]` | Triggers validation even when invalid; disabled only while submitting. |
| Server error alert | `[data-testid="setup-server-error"]` | Displays `serverError()`. | | Server error alert | `[data-testid="setup-server-error"]` | Displays `serverError()`. |
| Retry button | `[data-testid="setup-retry"]` | Re-submits; absent when the error is non-retryable. | | Retry button | `[data-testid="setup-retry"]` | Re-submits; absent when the error is non-retryable. |
| Password policy hint | `.hint` | Live description from `BootstrapService.passwordPolicy()`. | | Password policy hint | `.hint` | Live description from `BootstrapService.passwordPolicy()`. |
docs/index.md
+1 -1
View File
@@ -11,7 +11,7 @@ scoreboard, an event window with a public countdown, theming, and admin
controls. controls.
The docs below are organized by purpose so agents can pull just the slice The docs below are organized by purpose so agents can pull just the slice
they need. Last regenerated 2026-07-21. they need. Last regenerated 2026-07-21T16:09:53Z.
# Architecture # Architecture