generated from nhcarrigan/template
docs: document personality project from feature branch
This commit is contained in:
@@ -773,7 +773,7 @@ export const navigation = [
|
||||
{
|
||||
label: "Personality",
|
||||
link: "/projects/personality",
|
||||
badge: { text: "unversioned", variant: "success" },
|
||||
badge: { text: "v1.0.0", variant: "tip" },
|
||||
},
|
||||
{
|
||||
label: "QR Generator",
|
||||
|
||||
@@ -2,36 +2,73 @@
|
||||
title: Personality
|
||||
---
|
||||
|
||||
Personality (hereinafter the "Application") is
|
||||
Personality (hereinafter the "Application") is a personal values and self-reflection hub built as an Astro site.
|
||||
|
||||
## 1. User Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The Application currently presents multiple self-exploration sections from a shared home dashboard:
|
||||
|
||||
This section is for those interacting with a live instance of the Application.
|
||||
1. Values (`/values`)
|
||||
2. Personality test results (`/personality`)
|
||||
3. Natal chart (`/astrology`)
|
||||
4. DBT exercise progress (`/dbt`)
|
||||
5. Playroom/social templates (`/playroom`)
|
||||
|
||||
The home page also links to an external user manual at `https://manual.nhcarrigan.com`.
|
||||
|
||||
Current content behavior in the app:
|
||||
|
||||
1. Personality tests are rendered from structured test data (for example MBTI, Big Five, Enneagram, attachment style, and VIA strengths).
|
||||
2. Astrology content is grouped into personal, social, generational, and points/angles categories.
|
||||
3. DBT modules display progress counters based on completed exercises.
|
||||
|
||||
## 2. Technical Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The active implementation currently lives on the `origin/feat/init` branch of the Personality repository.
|
||||
|
||||
This section is for those interested in running their own instance of the Application.
|
||||
Project stack and structure:
|
||||
|
||||
1. Astro `6.1.8`
|
||||
2. TypeScript `6.0.3`
|
||||
3. Flat content pages in `src/pages`
|
||||
4. Static data modules in `src/data`
|
||||
|
||||
Key routes in source:
|
||||
|
||||
1. `src/pages/index.astro`
|
||||
2. `src/pages/values.astro`
|
||||
3. `src/pages/personality.astro`
|
||||
4. `src/pages/astrology.astro`
|
||||
5. `src/pages/dbt.astro`
|
||||
6. `src/pages/playroom.astro`
|
||||
|
||||
Primary commands from `package.json`:
|
||||
|
||||
1. `pnpm install`
|
||||
2. `pnpm run dev`
|
||||
3. `pnpm run build`
|
||||
4. `pnpm run lint`
|
||||
|
||||
Current repository version is `1.0.0`.
|
||||
|
||||
## 3. Legal Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The Application uses the shared nhcarrigan legal policies:
|
||||
|
||||
This section is for expansions to our legal policies specific to the Application.
|
||||
1. Privacy Policy: https://docs.nhcarrigan.com/#/privacy
|
||||
2. Terms of Service: https://docs.nhcarrigan.com/#/terms
|
||||
3. License: https://docs.nhcarrigan.com/#/license
|
||||
|
||||
Repository references:
|
||||
|
||||
1. `PRIVACY.md`
|
||||
2. `TERMS.md`
|
||||
3. `LICENSE.md`
|
||||
|
||||
## 4. Contributing Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
Contribution guidance points to the shared docs portal:
|
||||
|
||||
This section is for documentation related to contributing to the Application's codebase.
|
||||
1. https://docs.nhcarrigan.com/#/contributing
|
||||
|
||||
The repository also includes the standard community files (`CODE_OF_CONDUCT.md`, `SECURITY.md`) for project participation and disclosure expectations.
|
||||
Reference in New Issue
Block a user