feat: some docs

This commit is contained in:
TrèsAbhi committed 2025-12-26 14:21:04 -06:00
1 parent 40a1eb861d
commit 53d05e73a6
2 files changed
+14 -2

No files matched your search

@@ -1,8 +1,13 @@
import { TankClass, TankType } from "@blitzkit/core";
import { Nation } from "@protos/blitz_static_tank_component"; import { Nation } from "@protos/blitz_static_tank_component";
import type { APIContext, GetStaticPaths } from "astro"; import type { APIContext, GetStaticPaths } from "astro";
import { GunType } from "../../../core/tankopedia/characteristics";
const enums = { const enums = {
nation: Nation, nation: Nation,
"tank-class": TankClass,
"tank-type": TankType,
"gun-type": GunType,
}; };
export const getStaticPaths = (() => { export const getStaticPaths = (() => {
@@ -10,7 +15,14 @@ export const getStaticPaths = (() => {
}) satisfies GetStaticPaths; }) satisfies GetStaticPaths;
/** /**
* The one who wipes, swipes. * Enumerations used within BlitzKit, for nominal development reference only.
*
* DO NOT programmatically use this API as it is designed solely for human
* reference.
*
* DO NOT blindly copy entries as naming conventions vary. Most enums come
* directly from the game which uses a SCREAMING_SNAKE_CASE convention while
* BlitzKit uses PascalCase.
*/ */
export function GET({ export function GET({
params, params,
@@ -51,7 +51,7 @@ paths.sort((a, b) => a.path.localeCompare(b.path));
paths.map(({ path, documentation }) => ( paths.map(({ path, documentation }) => (
<> <>
<h2>{path}</h2> <h2>{path}</h2>
<p>{documentation}</p> <pre>{documentation}</pre>
</> </>
)) ))
} }