ilenia
00242450a7
### Explanation there were missing files, and some were already released, so those get a full docs page, not just the boilerplate took a look around also at other docs and updated some ### Issue _No response_ ### Attestations - [x] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/) - [x] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). - [x] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). ### Dependencies - [ ] I have pinned the dependencies to a specific patch version. ### Style - [x] I have run the linter and resolved any errors. - [x] My pull request uses an appropriate title, matching the conventional commit standards. - [x] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. ### Tests - [ ] My contribution adds new code, and I have added tests to cover it. - [ ] My contribution modifies existing code, and I have updated the tests to reflect these changes. - [x] All new and existing tests pass locally with my changes. - [ ] Code coverage remains at or above the configured threshold. ### Documentation this one =) ### Versioning Minor - My pull request introduces a new non-breaking feature. Reviewed-on: #40 Co-authored-by: Ilenia <ilenia@nhcarrigan.com> Co-committed-by: Ilenia <ilenia@nhcarrigan.com>
1.7 KiB
title
| title |
|---|
| Lore |
Lore (hereinafter the "Application") is a web application that publishes lore and reference material for Naomi's fictional persona and characters.
1. User Documentation
The live site is available at https://lore.nhcarrigan.com.
Visitors can browse structured lore content through dedicated pages including:
- Home
- Handbook
- About
- FAQ
- Reviews
- Staff
Site copy and supporting data are maintained in the application source and loaded through Angular components and config files.
2. Technical Documentation
Lore is built with Angular and uses a standard Angular CLI workflow.
Local development:
- Install dependencies with
pnpm install. - Run local dev server with
pnpm start. - Build production bundle with
pnpm build. - Run tests with
pnpm test. - Run lint checks with
pnpm lint.
Implementation notes:
- Route definitions are in
src/app/app.routes.ts. - Main feature areas are component-based under
src/app/*. - Shared content/config values are maintained in
src/app/config/*. - Styling includes project CSS and Tailwind/PostCSS tooling.
3. Legal Documentation
Project policy files reference global documentation:
- License:
https://docs.nhcarrigan.com/#/license - Terms:
https://docs.nhcarrigan.com/#/terms - Privacy:
https://docs.nhcarrigan.com/#/privacy - Security:
https://docs.nhcarrigan.com/#/security
Copyright is held by Naomi Carrigan.
4. Contributing Documentation
Contributions are accepted through pull requests under the repository's contribution policy and Code of Conduct.
Before opening a pull request:
- Run
pnpm install. - Run
pnpm lint. - Run
pnpm test. - Run
pnpm build.
Feedback and bug reports are handled via https://support.nhcarrigan.com.