docs: document lore project and update nav badge

This commit is contained in:
2026-07-01 13:51:21 +02:00
parent c87b58570c
commit 1f2d3248eb
2 changed files with 44 additions and 18 deletions
+1 -1
View File
@@ -733,7 +733,7 @@ export const navigation = [
{
label: "Lore",
link: "/projects/lore",
badge: { text: "unreleased", variant: "danger" },
badge: { text: "v0.0.0", variant: "caution" },
},
{
label: "Hikari Desktop",
+43 -17
View File
@@ -2,36 +2,62 @@
title: Lore
---
Lore (hereinafter the "Application") is
Lore (hereinafter the "Application") is a web application that publishes lore and reference material for Naomi's fictional persona and characters.
## 1. User Documentation
:::note
This section is coming soon!
:::
The live site is available at `https://lore.nhcarrigan.com`.
This section is for those interacting with a live instance of the Application.
Visitors can browse structured lore content through dedicated pages including:
1. Home
2. Handbook
3. About
4. FAQ
5. Reviews
6. Staff
Site copy and supporting data are maintained in the application source and loaded through Angular components and config files.
## 2. Technical Documentation
:::note
This section is coming soon!
:::
Lore is built with Angular and uses a standard Angular CLI workflow.
This section is for those interested in running their own instance of the Application.
Local development:
1. Install dependencies with `pnpm install`.
2. Run local dev server with `pnpm start`.
3. Build production bundle with `pnpm build`.
4. Run tests with `pnpm test`.
5. Run lint checks with `pnpm lint`.
Implementation notes:
1. Route definitions are in `src/app/app.routes.ts`.
2. Main feature areas are component-based under `src/app/*`.
3. Shared content/config values are maintained in `src/app/config/*`.
4. Styling includes project CSS and Tailwind/PostCSS tooling.
## 3. Legal Documentation
:::note
This section is coming soon!
:::
Project policy files reference global documentation:
This section is for expansions to our legal policies specific to the Application.
1. License: `https://docs.nhcarrigan.com/#/license`
2. Terms: `https://docs.nhcarrigan.com/#/terms`
3. Privacy: `https://docs.nhcarrigan.com/#/privacy`
4. Security: `https://docs.nhcarrigan.com/#/security`
Copyright is held by Naomi Carrigan.
## 4. Contributing Documentation
:::note
This section is coming soon!
:::
Contributions are accepted through pull requests under the repository's contribution policy and Code of Conduct.
This section is for documentation related to contributing to the Application's codebase.
Before opening a pull request:
1. Run `pnpm install`.
2. Run `pnpm lint`.
3. Run `pnpm test`.
4. Run `pnpm build`.
Feedback and bug reports are handled via `https://support.nhcarrigan.com`.