docs: update documentation to OKF v0.1 format
This commit is contained in:
+7
-4
@@ -8,10 +8,11 @@ HIPCTF is a single-tenant CTF (Capture-The-Flag) platform built as a Node.js
|
||||
monorepo containing a NestJS REST API and an Angular single-page application.
|
||||
It supports user registration, authentication, challenge management, a live
|
||||
scoreboard, an event window with a public countdown, theming, and admin
|
||||
controls.
|
||||
controls, administrator-managed Markdown blog publishing, and public and
|
||||
signed-in blog views.
|
||||
|
||||
The docs below are organized by purpose so agents can pull just the slice
|
||||
they need. Last regenerated 2026-07-23T08:42:24Z.
|
||||
they need. Last regenerated 2026-07-23T10:12:24Z.
|
||||
|
||||
# Architecture
|
||||
|
||||
@@ -61,6 +62,7 @@ they need. Last regenerated 2026-07-23T08:42:24Z.
|
||||
streams, public event-window settings, and the authenticated
|
||||
`/events/status` SSE stream.
|
||||
* [Uploads Endpoints](/api/uploads.md) - Admin-only multipart uploads for category icons, challenge files, and validated site logos.
|
||||
* [Blog Endpoints](/api/blog.md) - Public published-post listing and admin-only post CRUD, validation, and publication behavior.
|
||||
|
||||
# Guides
|
||||
|
||||
@@ -70,8 +72,9 @@ they need. Last regenerated 2026-07-23T08:42:24Z.
|
||||
helpers that translate reactive-form state into the inline validation
|
||||
messages on the first-admin modal.
|
||||
* [Admin Shell & Side Navigation](/guides/admin-shell.md) - How admins
|
||||
navigate the post-login admin area side-nav (General, Challenges,
|
||||
Players, Blog, System) and reach the enabled child pages.
|
||||
navigate the post-login admin area side-nav and reach General,
|
||||
Challenges, Players, and Blog pages.
|
||||
* [Blog Publishing and Reading](/guides/blog.md) - How administrators create, preview, draft, publish, edit, and delete Markdown posts and how users read them.
|
||||
* [Admin — General Settings](/guides/admin-general-settings.md) - How an
|
||||
admin edits platform-wide settings, including the required and strictly
|
||||
ordered event window, at `/admin/general`.
|
||||
|
||||
Reference in New Issue
Block a user