nhcarrigan/docs
11
0
Fork 0
generated from nhcarrigan/template
Code Issues 2 Pull Requests 7 Actions Releases 1 Activity

Compare commits

base: nhcarrigan/docs:main
Branches Tags
nhcarrigan/docs:main nhcarrigan/docs:dependencies/update-typescript nhcarrigan/docs:fix/issue-34-vite-rollback nhcarrigan/docs:dependencies/update-mermaid nhcarrigan/docs:dependencies/update-cspell nhcarrigan/docs:dependencies/update--astrojs-starlight nhcarrigan/docs:dependencies/update-astro nhcarrigan/docs:dependencies/update-vitest nhcarrigan/docs:dependencies/update-astro-mermaid nhcarrigan/docs:fix/remove-forum-references nhcarrigan/docs:chore/audit-contributing-docs
nhcarrigan/docs:v1.0.0
..
compare: nhcarrigan/docs:76a402d21517dab990958284bb298a8821329748
Branches Tags
nhcarrigan/docs:main nhcarrigan/docs:dependencies/update-typescript nhcarrigan/docs:fix/issue-34-vite-rollback nhcarrigan/docs:dependencies/update-mermaid nhcarrigan/docs:dependencies/update-cspell nhcarrigan/docs:dependencies/update--astrojs-starlight nhcarrigan/docs:dependencies/update-astro nhcarrigan/docs:dependencies/update-vitest nhcarrigan/docs:dependencies/update-astro-mermaid nhcarrigan/docs:fix/remove-forum-references nhcarrigan/docs:chore/audit-contributing-docs
nhcarrigan/docs:v1.0.0

6 Commits
main .. 76a402d215

Author SHA1 Message Date
naomi 76a402d215 feat: tighten and clean up policies
Node.js CI / Lint and Test (pull_request) Failing after 52s
Details
2025-12-12 20:32:49 -08:00
naomi aa0a851c9f feat: development reviews 2025-12-12 20:28:53 -08:00
naomi 0b93ab7892 feat: services are free, but limited to active community members 2025-12-12 20:03:17 -08:00
naomi 039d452806 feat: mock interview and portfolio reviews 2025-12-12 19:54:07 -08:00
naomi 549a71f77a feat: add policy for requesting recommendations/referrals 2025-12-12 14:33:47 -08:00
naomi 5633eae911 feat: add template for appeal denial 2025-12-12 13:08:39 -08:00
149 changed files with 7942 additions and 99251 deletions
Expand all files Collapse all files
.cspell.json
+2 -15
View File
@@ -12,8 +12,8 @@
"bash"
],
"ignoreRegExpList": [
"```[\\s\\S]*?```",
"`[^`\n]+`"
"```[\\s\\S]*?```", // Ignores multi-line code blocks in Markdown
"`[^`\n]+`" // Ignores inline code blocks
],
"ignoreWords": [
"nhcarrigan",
@@ -54,7 +54,6 @@
"Callista",
"CCPA",
"Celestine",
"Chronara",
"Čeština",
"CFAA",
"Chibika",
@@ -64,10 +63,8 @@
"Eclaire",
"Eirene",
"Elaria",
"Ephemere",
"Elowyn",
"Elunara",
"Enneagram",
"equivalencies",
"escalatory",
"excludable",
@@ -97,16 +94,11 @@
"Meridia",
"MERN",
"MEVN",
"MBTI",
"minimis",
"Minori",
"Mommy",
"NAMI",
"NCMEC",
"Nederlands",
"Neurodivergence",
"Nomena",
"NSFW",
"Nymira",
"OFAC",
"Ollama",
@@ -120,7 +112,6 @@
"recuse",
"Reddiquette",
"Română",
"Rondelle",
"Rosalia",
"Saisoku",
"Sakura",
@@ -130,8 +121,6 @@
"Svenska",
"Sylvara",
"Taryne",
"Tauri",
"Tatsumi",
"Tessara",
"Thalassa",
"Thessalia",
@@ -139,13 +128,11 @@
"Umbrelle",
"Veluna",
"Verena",
"Valerium",
"Vitalia",
"Vivicrea",
"Vivienne",
"vtubing",
"WCAG",
"Yubi",
"Zephra",
"zirs",
"Ελληνικά",
.gitea/workflows/ci.yml
+6 -15
View File
@@ -8,31 +8,22 @@ on:
- main
jobs:
ci:
name: CI
runs-on: ubuntu-latest
lint:
name: Lint and Test
steps:
- name: Checkout Source Files
uses: actions/checkout@v4
- name: Use Node.js v24
- name: Use Node.js v22
uses: actions/setup-node@v4
with:
node-version: 24
node-version: 22
- name: Setup pnpm
uses: pnpm/action-setup@v2
with:
version: 10
- name: Ensure Dependencies are Pinned
uses: naomi-lgbt/dependency-pin-check@main
with:
language: javascript
dev-dependencies: true
peer-dependencies: true
optional-dependencies: true
version: 9
- name: Install Dependencies
run: pnpm install
@@ -44,4 +35,4 @@ jobs:
run: pnpm run build
- name: Run Tests
run: pnpm run test
run: pnpm run test
.gitea/workflows/security.yml
-177
View File
@@ -1,177 +0,0 @@
name: Security Scan and Upload
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
- cron: '0 0 * * 1'
workflow_dispatch:
jobs:
security-audit:
name: Security & DefectDojo Upload
runs-on: ubuntu-latest
continue-on-error: true
steps:
- name: Checkout code
uses: actions/checkout@v4
# --- AUTO-SETUP PROJECT ---
- name: Ensure DefectDojo Product Exists
env:
DD_URL: ${{ secrets.DD_URL }}
DD_TOKEN: ${{ secrets.DD_TOKEN }}
PRODUCT_NAME: ${{ github.repository }}
PRODUCT_TYPE_ID: 1
run: |
sudo apt-get install jq -y > /dev/null
echo "Checking connection to $DD_URL..."
# Check if product exists - capture HTTP code to debug connection issues
RESPONSE=$(curl --write-out "%{http_code}" --silent --output /tmp/response.json \
-H "Authorization: Token $DD_TOKEN" \
"$DD_URL/api/v2/products/?name=$PRODUCT_NAME")
# If response is not 200, print error
if [ "$RESPONSE" != "200" ]; then
echo "::error::Failed to query DefectDojo. HTTP Code: $RESPONSE"
cat /tmp/response.json
exit 1
fi
COUNT=$(cat /tmp/response.json | jq -r '.count')
if [ "$COUNT" = "0" ]; then
echo "Creating product '$PRODUCT_NAME'..."
curl -s -X POST "$DD_URL/api/v2/products/" \
-H "Authorization: Token $DD_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "'"$PRODUCT_NAME"'", "description": "Auto-created by Gitea Actions", "prod_type": '$PRODUCT_TYPE_ID' }'
else
echo "Product '$PRODUCT_NAME' already exists."
fi
# --- 1. TRIVY (Dependencies & Misconfig) ---
- name: Install Trivy
run: |
sudo apt-get install wget apt-transport-https gnupg lsb-release -y
wget -qO - https://aquasecurity.github.io/trivy-repo/deb/public.key | sudo apt-key add -
echo "deb https://aquasecurity.github.io/trivy-repo/deb $(lsb_release -sc) main" | sudo tee -a /etc/apt/sources.list.d/trivy.list
sudo apt-get update && sudo apt-get install trivy -y
- name: Run Trivy (FS Scan)
run: |
trivy fs . --scanners vuln,misconfig --format json --output trivy-results.json --exit-code 0
- name: Upload Trivy to DefectDojo
env:
DD_URL: ${{ secrets.DD_URL }}
DD_TOKEN: ${{ secrets.DD_TOKEN }}
run: |
echo "Uploading Trivy results..."
# Generate today's date in YYYY-MM-DD format
TODAY=$(date +%Y-%m-%d)
HTTP_CODE=$(curl --write-out "%{http_code}" --output response.txt --silent -X POST "$DD_URL/api/v2/import-scan/" \
-H "Authorization: Token $DD_TOKEN" \
-F "active=true" \
-F "verified=true" \
-F "scan_type=Trivy Scan" \
-F "engagement_name=CI/CD Pipeline" \
-F "product_name=${{ github.repository }}" \
-F "scan_date=$TODAY" \
-F "auto_create_context=true" \
-F "file=@trivy-results.json")
if [[ "$HTTP_CODE" != "200" && "$HTTP_CODE" != "201" ]]; then
echo "::error::Upload Failed with HTTP $HTTP_CODE"
echo "--- SERVER RESPONSE ---"
cat response.txt
echo "-----------------------"
exit 1
else
echo "Upload Success!"
fi
# --- 2. GITLEAKS (Secrets) ---
- name: Install Gitleaks
run: |
wget -qO gitleaks.tar.gz https://github.com/gitleaks/gitleaks/releases/download/v8.18.0/gitleaks_8.18.0_linux_x64.tar.gz
tar -xzf gitleaks.tar.gz
sudo mv gitleaks /usr/local/bin/ && chmod +x /usr/local/bin/gitleaks
- name: Run Gitleaks
run: gitleaks detect --source . -v --report-path gitleaks-results.json --report-format json --no-git || true
- name: Upload Gitleaks to DefectDojo
env:
DD_URL: ${{ secrets.DD_URL }}
DD_TOKEN: ${{ secrets.DD_TOKEN }}
run: |
echo "Uploading Gitleaks results..."
TODAY=$(date +%Y-%m-%d)
HTTP_CODE=$(curl --write-out "%{http_code}" --output response.txt --silent -X POST "$DD_URL/api/v2/import-scan/" \
-H "Authorization: Token $DD_TOKEN" \
-F "active=true" \
-F "verified=true" \
-F "scan_type=Gitleaks Scan" \
-F "engagement_name=CI/CD Pipeline" \
-F "product_name=${{ github.repository }}" \
-F "scan_date=$TODAY" \
-F "auto_create_context=true" \
-F "file=@gitleaks-results.json")
if [[ "$HTTP_CODE" != "200" && "$HTTP_CODE" != "201" ]]; then
echo "::error::Upload Failed with HTTP $HTTP_CODE"
echo "--- SERVER RESPONSE ---"
cat response.txt
echo "-----------------------"
exit 1
else
echo "Upload Success!"
fi
# --- 3. SEMGREP (SAST) ---
- name: Install Semgrep (via pipx)
run: |
sudo apt-get install pipx -y
pipx install semgrep
# Add pipx binary path to GITHUB_PATH so next steps can see 'semgrep'
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Run Semgrep
run: semgrep scan --config=p/security-audit --config=p/owasp-top-ten --json --output semgrep-results.json . || true
- name: Upload Semgrep to DefectDojo
env:
DD_URL: ${{ secrets.DD_URL }}
DD_TOKEN: ${{ secrets.DD_TOKEN }}
run: |
echo "Uploading Semgrep results..."
TODAY=$(date +%Y-%m-%d)
HTTP_CODE=$(curl --write-out "%{http_code}" --output response.txt --silent -X POST "$DD_URL/api/v2/import-scan/" \
-H "Authorization: Token $DD_TOKEN" \
-F "active=true" \
-F "verified=true" \
-F "scan_type=Semgrep JSON Report" \
-F "engagement_name=CI/CD Pipeline" \
-F "product_name=${{ github.repository }}" \
-F "scan_date=$TODAY" \
-F "auto_create_context=true" \
-F "file=@semgrep-results.json")
if [[ "$HTTP_CODE" != "200" && "$HTTP_CODE" != "201" ]]; then
echo "::error::Upload Failed with HTTP $HTTP_CODE"
echo "--- SERVER RESPONSE ---"
cat response.txt
echo "-----------------------"
exit 1
else
echo "Upload Success!"
fi
README.md
+33 -15
View File
@@ -1,29 +1,47 @@
# docs
# Astro Starter Kit: Minimal
Documentation for NHCarrigan projects.
```sh
npm create astro@latest -- --template minimal
```
## Live Version
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
This page is currently deployed. [View the live website.](https://docs.nhcarrigan.com)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## Feedback and Bugs
## 🚀 Project Structure
If you have feedback or a bug report, please [log a ticket on our forum](https://support.nhcarrigan.com).
Inside of your Astro project, you'll see the following folders and files:
## Contributing
```text
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
```
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first.
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
## Code of Conduct
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
Any static assets, like images, can be placed in the `public/` directory.
## License
## 🧞 Commands
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
All commands are run from the root of the project, from a terminal:
Copyright held by Naomi Carrigan.
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## Contact
## 👀 Want to learn more?
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
package.json
+7 -7
View File
@@ -12,16 +12,16 @@
"test": "vitest --run"
},
"dependencies": {
"@astrojs/check": "0.9.9",
"@astrojs/starlight": "0.40.0",
"astro": "6.4.8",
"astro-mermaid": "2.0.4",
"mermaid": "11.12.2",
"@astrojs/check": "0.9.5",
"@astrojs/starlight": "0.36.1",
"astro": "5.15.2",
"astro-mermaid": "1.1.0",
"mermaid": "11.12.1",
"typescript": "5.9.3"
},
"devDependencies": {
"cspell": "9.4.0",
"cspell": "9.2.2",
"gray-matter": "4.0.3",
"vitest": "4.1.9"
"vitest": "4.0.5"
}
}
pnpm-lock.yaml
Generated
+2991 -2248
View File
File diff suppressed because it is too large Load Diff
pnpm-workspace.yaml
-31
View File
@@ -1,31 +0,0 @@
# Security
# Do not execute any scripts of installed packages (project scripts still run)
ignoreDepScripts: true
# Do not automatically run pre/post scripts (e.g. preinstall, postbuild)
enablePrePostScripts: false
# Only allow packages published at least 10 days ago (reduces risk of compromised packages)
minimumReleaseAge: 14400
# Fail if a package's trust level has decreased compared to previous releases
trustPolicy: no-downgrade
# Ignore trust policy for packages published more than 1 year ago (predates provenance signing)
trustPolicyIgnoreAfter: 525960
# Fail if there are missing or invalid peer dependencies
strictPeerDependencies: true
# Prevent transitive dependencies from using exotic sources (git repos, direct tarball URLs)
blockExoticSubdeps: true
overrides:
nanoid: 3.3.11
packageExtensions:
langium@*:
dependencies:
vscode-jsonrpc: 8.2.1
# Lockfile
# Allow the lockfile to be updated during install (set to true in CI for stricter reproducibility)
preferFrozenLockfile: false
allowBuilds:
esbuild: false
sharp: false
public/favicon.svg
+1342 -86507
View File
File diff suppressed because one or more lines are too long
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.9 MiB

After

Width:  |  Height:  |  Size: 1.6 MiB

public/logo.png
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 6.0 MiB

After

Width:  |  Height:  |  Size: 1.3 MiB

src/components/navigation.ts
+40 -157
View File
@@ -1,6 +1,5 @@
export const navigation = [
{
// #region About Us
label: "About Us",
collapsed: true,
items: [
@@ -28,30 +27,8 @@ export const navigation = [
label: "Mentorship Programme Terms and Conditions",
link: "/about/mentorship",
},
{
label: "Development Review Policy",
link: "/about/development-reviews",
},
{
label: "Mock Interview Policy",
link: "/about/mock-interviews",
},
{
label: "Portfolio Review Policy",
link: "/about/portfolio-reviews",
},
{
label: "Letter of Recommendation and Character Reference Policy",
link: "/about/recommendations",
},
{
label: "Community Membership Eligibility",
link: "/about/community-membership-eligibility",
},
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Legal Information
{
label: "Legal Information",
collapsed: true,
@@ -118,8 +95,6 @@ export const navigation = [
},
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Community Policies
{
label: "Community Policies",
collapsed: true,
@@ -148,14 +123,8 @@ export const navigation = [
label: "Community Feedback and Participation Policy",
link: "/community/feedback",
},
{
label: "Fan Art Guidelines",
link: "/community/fan-art",
}
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Development Documentation
{
label: "Development Documentation",
collapsed: true,
@@ -180,14 +149,20 @@ export const navigation = [
label: "Development Environment",
link: "/dev/environment",
},
{
label: "Server Setup",
link: "/dev/servers",
},
{
label: "Naomi's VTubing Setup",
link: "/dev/vtubing",
},
{
label: "Security Hall of Fame",
link: "/dev/hall-of-fame",
}
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Mentorship Programme
{
label: "Mentorship Programme",
collapsed: true,
@@ -284,8 +259,6 @@ export const navigation = [
}
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Project Documentation
{
label: "Project Documentation",
collapsed: true,
@@ -293,7 +266,7 @@ export const navigation = [
{
label: "ESLint Config",
link: "/projects/eslint-config",
badge: { text: "v5.2.0", variant: "tip" },
badge: { text: "v5.1.0", variant: "tip" },
},
{
label: "Aria Iuvo",
@@ -358,7 +331,7 @@ export const navigation = [
{
label: "Logger",
link: "/projects/logger",
badge: { text: "v1.1.1", variant: "tip" },
badge: { text: "v1.0.0", variant: "tip" },
},
{
label: "Resume",
@@ -378,7 +351,7 @@ export const navigation = [
{
label: "Website Headers",
link: "/projects/website-headers",
badge: { text: "v4.1.0", variant: "tip" },
badge: { text: "v2.1.0", variant: "tip" },
},
{
label: "Altaria",
@@ -448,7 +421,7 @@ export const navigation = [
{
label: "Vitalia",
link: "/projects/vitalia",
badge: { text: "v0.0.0", variant: "caution" },
badge: { text: "unreleased", variant: "danger" },
},
{
label: "Octavia",
@@ -458,7 +431,7 @@ export const navigation = [
{
label: "Maribelle",
link: "/projects/maribelle",
badge: { text: "v0.0.0", variant: "caution" },
badge: { text: "unreleased", variant: "danger" },
},
{
label: "Verena",
@@ -573,7 +546,7 @@ export const navigation = [
{
label: "Elysium",
link: "/projects/elysium",
badge: { text: "v0.5.0", variant: "caution" },
badge: { text: "unreleased", variant: "danger" },
},
{
label: "Elaria",
@@ -608,7 +581,7 @@ export const navigation = [
{
label: "Lucinda",
link: "/projects/lucinda",
badge: { text: "v0.0.0", variant: "caution" },
badge: { text: "unreleased", variant: "danger" },
},
{
label: "Liora",
@@ -673,7 +646,7 @@ export const navigation = [
{
label: "Eclaire",
link: "/projects/eclaire",
badge: { text: "v1.1.0", variant: "tip" },
badge: { text: "v1.0.0", variant: "tip" },
},
{
label: "freeCodeCamp Review Generator",
@@ -720,70 +693,8 @@ export const navigation = [
link: "/projects/vivicrea",
badge: { text: "v1.0.0", variant: "tip" },
},
{
label: "Ephemere",
link: "/projects/ephemere",
badge: { text: "unversioned", variant: "success" },
},
{
label: "Valerium",
link: "/projects/valerium",
badge: { text: "v1.0.1", variant: "tip" },
},
{
label: "Lore",
link: "/projects/lore",
badge: { text: "v0.0.0", variant: "caution" },
},
{
label: "Hikari Desktop",
link: "/projects/hikari-desktop",
badge: { text: "v1.15.0", variant: "tip" },
},
{
label: "Rondelle",
link: "/projects/rondelle",
badge: { text: "unversioned", variant: "success" },
},
{
label: "Chronara",
link: "/projects/chronara",
badge: { text: "unversioned", variant: "success" },
},
{
label: "Silly Sites",
link: "/projects/silly-sites",
badge: { text: "unversioned", variant: "success" },
},
{
label: "Library",
link: "/projects/library",
badge: { text: "v1.1.1", variant: "tip" },
},
{
label: "Minori",
link: "/projects/minori",
badge: { text: "unreleased", variant: "danger" },
},
{
label: "Tatsumi",
link: "/projects/tatsumi",
badge: { text: "v1.2.0", variant: "tip" },
},
{
label: "Personality",
link: "/projects/personality",
badge: { text: "v1.0.0", variant: "tip" },
},
{
label: "QR Generator",
link: "/projects/qr-generator",
badge: { text: "v1.0.0", variant: "tip" },
},
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region Staff Guidelines
{
label: "Staff Guidelines",
collapsed: true,
@@ -808,10 +719,6 @@ export const navigation = [
label: "Join Our Volunteer Team",
link: "/staff/apply",
},
{
label: "Self-Care Resources for Staff",
link: "/staff/self-care-resources",
},
{
label: "Staff Application Evaluation Rubric",
link: "/staff/rubric",
@@ -824,14 +731,6 @@ export const navigation = [
label: "Accessibility Coordination Training for Staff",
link: "/staff/training/accessibility-coordination",
},
{
label: "Bias Recognition and Mitigation Training for Staff",
link: "/staff/training/bias-recognition-mitigation",
},
{
label: "Child Safety Training for Staff",
link: "/staff/training/child-safety",
},
{
label: "Community Growth Specialist Training for Staff",
link: "/staff/training/community-growth-specialist",
@@ -844,14 +743,6 @@ export const navigation = [
label: "Conflict Resolution Training for Staff",
link: "/staff/training/conflict-resolution",
},
{
label: "Content Moderation Fundamentals Training for Staff",
link: "/staff/training/content-moderation-fundamentals",
},
{
label: "Criminal Activity Training for Staff",
link: "/staff/training/criminal-activity",
},
{
label: "Crisis Response Training for Staff",
link: "/staff/training/crisis-response",
@@ -864,26 +755,10 @@ export const navigation = [
label: "Data Analytics and Reporting Training for Staff",
link: "/staff/training/data-analytics-reporting",
},
{
label: "Data Privacy and GDPR Compliance Training for Staff",
link: "/staff/training/data-privacy-gdpr",
},
{
label: "De-escalation Techniques Training for Staff",
link: "/staff/training/de-escalation-techniques",
},
{
label: "Documentation and Transparency Training for Staff",
link: "/staff/training/documentation-transparency",
},
{
label: "Support Forum Moderation Training for Staff",
link: "/staff/training/forum-moderation",
},
{
label: "Harassment and Bullying Response Training for Staff",
link: "/staff/training/harassment-bullying-response",
},
{
label: "Inclusive Moderation Training for Staff",
link: "/staff/training/inclusive-moderation",
@@ -900,29 +775,37 @@ export const navigation = [
label: "Technical Contributor Training for Staff",
link: "/staff/training/technical-contributor",
},
{
label: "Trauma-Informed Moderation Training for Staff",
link: "/staff/training/trauma-informed-moderation",
},
].sort((a, b) => a.label.localeCompare(b.label)),
},
{
label: "Staff Policy Self-Assessment",
link: "/staff/policy-self-assessment",
},
].sort((a, b) => a.label.localeCompare(b.label)),
},
// #endregion
// #region External Links
{
label: "Discord",
link: "https://chat.nhcarrigan.com",
label: "Miscellaneous Documents",
collapsed: true,
items: [
{
label: "Managing Local Music",
link: "/misc/music",
},
{
label: "Templates",
link: "/misc/templates",
},
{
label: "AI Prompts",
link: "/misc/prompts",
}
].sort((a, b) => a.label.localeCompare(b.label)),
},
{
label: "Sitemap",
link: "https://sitemap.nhcarrigan.com",
attrs: {
target: "_blank",
},
},
{
label: "Support Forum",
link: "https://support.nhcarrigan.com",
attrs: {
target: "_blank",
},
}
// #endregion
];
src/content.config.ts
-10
View File
@@ -1,10 +0,0 @@
import { defineCollection } from "astro:content";
import { glob } from "astro/loaders";
import { docsSchema } from "@astrojs/starlight/schema";
export const collections = {
docs: defineCollection({
loader: glob({ pattern: "**/*.{md,mdx}", base: "./src/content/docs" }),
schema: docsSchema(),
}),
};
src/content/config.ts
+6
View File
@@ -0,0 +1,6 @@
import { defineCollection } from 'astro:content';
import { docsSchema } from '@astrojs/starlight/schema';
export const collections = {
docs: defineCollection({ schema: docsSchema() }),
};
src/content/docs/about/community-membership-eligibility.md
-83
View File
@@ -1,83 +0,0 @@
---
title: Community Membership Eligibility
---
**ELIGIBILITY REQUIREMENTS FOR FREE SERVICES**
## 1. INTRODUCTION AND SCOPE
### 1.1. Policy Overview
This Community Membership Eligibility Policy ("Policy") establishes the eligibility requirements for accessing free services provided by NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Scope of Application
This Policy applies to eligibility requirements for the following free services:
**(a)** Letters of recommendation and character references;
**(b)** Mock interviews and interview preparation;
**(c)** Portfolio reviews (resume, LinkedIn, GitHub, portfolio website reviews);
**(d)** Development reviews (code reviews, project planning consultations, technical writing reviews);
**(e)** Any other free services that require active community membership as a prerequisite.
## 2. ELIGIBILITY REQUIREMENT - ACTIVE COMMUNITY MEMBERSHIP
### 2.1. General Eligibility Standard
**IMPORTANT: Free services are provided EXCLUSIVELY to active members of our community. These services are NOT available to the general public or individuals who are not actively engaged in our community.**
### 2.2. Eligibility Criteria
**REQUIRED**: Requesters MUST be active, engaged members of our community with demonstrated participation, such as:
**(a)** Active participation in our mentorship programme;
**(b)** Regular, ongoing community engagement in our Discord server or other community platforms;
**(c)** Active volunteer work or contribution to community projects;
**(d)** Sustained, meaningful interaction demonstrating active community membership;
**(e)** Professional collaboration or work relationship within our community context (where applicable).
### 2.3. Verification and Discretion
**(a)** We will verify community membership and activity before accepting any service request;
**(b)** We reserve the right to decline requests from individuals who are not active community members, regardless of other factors;
**(c)** Casual acquaintanceship or minimal interaction does NOT qualify as active membership;
**(d)** We will not provide services for individuals we have not directly interacted with or who lack active community connection;
**(e)** Priority may be given to individuals from underrepresented groups in technology who are active community members.
## 3. NOT AN ACTIVE COMMUNITY MEMBER?
### 3.1. Becoming an Active Community Member
If you are not currently an active member of our community but are interested in accessing our free services, we encourage you to join our Discord community and become an active participant. Active community membership involves regular engagement, participation in discussions, and meaningful contribution to our community.
**Join our Discord community:** [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
Once you have established active community membership through regular participation and engagement, you will be eligible to request our free services. We look forward to welcoming you to our community!
### 3.2. What Constitutes Active Membership
Active community membership is demonstrated through:
**(a)** Regular participation in community discussions and activities;
**(b)** Meaningful contributions to community projects or initiatives;
**(c)** Consistent engagement over a period of time (not just a single interaction);
**(d)** Positive, constructive participation that aligns with our community values;
**(e)** Building relationships with other community members through genuine interaction.
## 4. LIMITATION OF LIABILITY AND DISCLAIMERS
### 4.1. Reference to Comprehensive Liability Framework
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
### 4.2. Eligibility Disclaimers
**(a)** Meeting eligibility criteria does not guarantee service provision;
**(b)** We reserve the right to decline service requests at our sole discretion;
**(c)** Eligibility determinations are final and not subject to appeal;
**(d)** This Policy may be updated at any time, and eligibility requirements may change.
---
*For questions about community membership eligibility or our free services, please contact us through our [Contact Policy](/about/contact).*
src/content/docs/about/contact.md
+17 -100
View File
@@ -128,16 +128,16 @@ Our Discord server allows for both quick and in-depth communication.
### 2.2. Code Repositories
Our code repositories are all self-hosted. Git accounts are only granted to Team members (volunteers) and Staff (paid employees).
Our code repositories are all self-hosted. Git accounts are only granted to staff members.
- Link: https://git.nhcarrigan.com
- Features:
- Issue tracking
- Source code for all of our products
- Best for: Viewing source code and documentation
- **Bug Reports and Feature Requests**: To report bugs or request features, please use our support forum:
- [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) for bug reports
- [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) for feature requests
- **Bug Reports and Feature Requests**: To report bugs or request features, please use our Discord forum channels:
- `#bug-reports` forum channel for bug reports
- `#feature-requests` forum channel for feature requests
### 2.3. Etiquette and Best Practices
@@ -199,7 +199,7 @@ LinkedIn serves as our primary professional networking platform.
#### 4.1.1. Connecting on LinkedIn
When sending a connection request, please include a brief message explaining your interest. We typically respond to LinkedIn messages within 7-10 business days.
When sending a connection request, please include a brief message explaining your interest. We typically respond to LinkedIn messages within 2-3 business days.
### 4.2. Professional Inquiries
@@ -236,12 +236,7 @@ We offer several email addresses for specific types of inquiries. Please use the
### 5.2. Billing and Financial Matters
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Billing Questions**](https://support.nhcarrigan.com/c/billing-questions/13) category on our support forum for billing inquiries. This allows for public discussion and faster responses. If you need to share sensitive financial information, you can ask staff to make your thread private, or contact us via email for complete confidentiality.
:::
- **Support Forum:** [Billing Questions](https://support.nhcarrigan.com/c/billing-questions/13) (preferred for most inquiries)
- Email: billing@nhcarrigan.com (for highly sensitive financial information requiring complete confidentiality)
- Email: billing@nhcarrigan.com
- Use for:
- Questions about payments or invoices
- Inquiries about outstanding balances
@@ -250,11 +245,6 @@ We encourage you to use the [**Billing Questions**](https://support.nhcarrigan.c
### 5.3. Technical Support
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Technical Support**](https://support.nhcarrigan.com/c/technical-support/5) category on our support forum for support inquiries. This allows for public discussion and faster responses. If you need to share sensitive information, you can ask staff to make your thread private, or contact us via email for complete confidentiality.
:::
- **Support Forum:** [Technical Support](https://support.nhcarrigan.com/c/technical-support/5) (preferred for most inquiries)
- Email: support@nhcarrigan.com
- Use for:
- Assistance with using our software or services
@@ -263,14 +253,7 @@ We encourage you to use the [**Technical Support**](https://support.nhcarrigan.c
### 5.4. Privacy Concerns
:::tip[Preferred Method]{icon=star}
We encourage you to use our **Privacy Request Form** for privacy-related requests: https://forms.nhcarrigan.com/o/docs/forms/qEJgBWGDfyHv6x51VU9aVX/4
This form helps ensure we collect all necessary information to process your request efficiently and in compliance with applicable data protection laws.
:::
- **Privacy Request Form** (Preferred): https://forms.nhcarrigan.com/o/docs/forms/qEJgBWGDfyHv6x51VU9aVX/4
- Email: privacy@nhcarrigan.com (for general privacy questions or if you prefer email)
- Email: privacy@nhcarrigan.com
- Use for:
- Questions about our privacy policy
- Requests for data access or deletion
@@ -279,15 +262,7 @@ This form helps ensure we collect all necessary information to process your requ
### 5.5. Security Matters
:::tip[Preferred Method]{icon=star}
We encourage you to use our **Security Vulnerability Report Form** for reporting security vulnerabilities: https://forms.nhcarrigan.com/o/docs/forms/wgdbBkS4tjCGoVZTqtmMNx/4
This form helps ensure we collect all necessary information to investigate and address security issues efficiently and securely.
:::
- **Security Vulnerability Report Form** (Preferred): https://forms.nhcarrigan.com/o/docs/forms/wgdbBkS4tjCGoVZTqtmMNx/4
- **Public Security Reports:** View aggregated and sanitized security vulnerability reports for all our products at: https://security.nhcarrigan.com/report/
- Email: security@nhcarrigan.com (for general security questions or if you prefer email)
- Email: security@nhcarrigan.com
- Use for:
- Reporting security vulnerabilities
- Questions about our security practices
@@ -295,12 +270,7 @@ This form helps ensure we collect all necessary information to investigate and a
### 5.6. Legal Inquiries
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Legal Notices**](https://support.nhcarrigan.com/c/legal-notices/12) category on our support forum for legal inquiries. This allows for public discussion and transparency. If you need to share sensitive legal information, you can ask staff to make your thread private, or contact us via email for urgent matters requiring immediate confidentiality.
:::
- **Support Forum:** [Legal Notices](https://support.nhcarrigan.com/c/legal-notices/12) (preferred for most inquiries)
- Email: legal@nhcarrigan.com (for urgent legal matters requiring immediate confidentiality)
- Email: legal@nhcarrigan.com
- Use for:
- Legal questions or concerns
- Copyright or trademark issues
@@ -309,18 +279,7 @@ We encourage you to use the [**Legal Notices**](https://support.nhcarrigan.com/c
### 5.7. Feedback and Suggestions
:::tip[Preferred Method]{icon=star}
We encourage you to use our support forum for different types of feedback:
- [**Community Feedback**](https://support.nhcarrigan.com/c/community-feedback/8) for general feedback about our community, services, events, and initiatives
- [**Policy Ideation**](https://support.nhcarrigan.com/c/policy-ideation/9) for suggestions about community policies and governance
- [**Accessibility Feedback**](https://support.nhcarrigan.com/c/accessibility-feedback/10) for reporting accessibility barriers and improvement suggestions
:::
- **Support Forum:**
- [Community Feedback](https://support.nhcarrigan.com/c/community-feedback/8) (preferred for general feedback)
- [Policy Ideation](https://support.nhcarrigan.com/c/policy-ideation/9) (preferred for policy suggestions)
- [Accessibility Feedback](https://support.nhcarrigan.com/c/accessibility-feedback/10) (preferred for accessibility matters)
- Email: feedback@nhcarrigan.com (if you prefer email communication)
- Email: feedback@nhcarrigan.com
- Use for:
- Providing feedback on our work or projects
- Suggesting improvements or new features
@@ -329,12 +288,7 @@ We encourage you to use our support forum for different types of feedback:
### 5.8. Press/Media Inquiries
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Press Inquiries**](https://support.nhcarrigan.com/c/press-inquiries/14) category on our support forum for media inquiries. This allows for public discussion and community visibility. If you need to share sensitive information, you can ask staff to make your thread private, or contact us via email for highly sensitive media matters requiring complete confidentiality.
:::
- **Support Forum:** [Press Inquiries](https://support.nhcarrigan.com/c/press-inquiries/14) (preferred for most inquiries)
- Email: press@nhcarrigan.com (for highly sensitive media matters requiring complete confidentiality)
- Email: press@nhcarrigan.com
- Use for:
- Requesting comment regarding news
- Scheduling interviews for your media outlet
@@ -351,12 +305,7 @@ We encourage you to use the [**Press Inquiries**](https://support.nhcarrigan.com
### 5.10. Marketing Inquiries
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Marketing Proposals**](https://support.nhcarrigan.com/c/marketing-proposals/15) category on our support forum for marketing inquiries. This allows for public discussion and community input. If you need to share highly confidential business information, you can ask staff to make your thread private, or contact us via email for proposals requiring complete privacy.
:::
- **Support Forum:** [Marketing Proposals](https://support.nhcarrigan.com/c/marketing-proposals/15) (preferred for most inquiries)
- Email: marketing@nhcarrigan.com (for highly confidential business proposals requiring complete privacy)
- Email: marketing@nhcarrigan.com
- Use for:
- Marketing collaboration proposals
- Brand partnership opportunities
@@ -374,12 +323,7 @@ We encourage you to use the [**Marketing Proposals**](https://support.nhcarrigan
### 5.12. Partnerships
:::tip[Preferred Method]{icon=star}
We encourage you to use the [**Partnership Requests**](https://support.nhcarrigan.com/c/partnership-requests/11) category on our support forum for partnership inquiries. This allows for public discussion and community input on potential partnerships. If you need to share sensitive business information, you can ask staff to make your thread private, or contact us via email if you need complete confidentiality from the start.
:::
- **Support Forum:** [Partnership Requests](https://support.nhcarrigan.com/c/partnership-requests/11) (preferred for most inquiries)
- Email: partners@nhcarrigan.com (if you need complete confidentiality from the start)
- Email: partners@nhcarrigan.com
- Use for:
- Requesting a collaboration between our organisation and yours
- Sponsorship opportunities for our work
@@ -391,8 +335,8 @@ We encourage you to use the [**Partnership Requests**](https://support.nhcarriga
- Subject Line: Please use a clear, concise subject line that summarizes your inquiry.
- Content: Provide all relevant details in your initial email to expedite the response process.
- Attachments: If sending attachments, please mention them in the email body and ensure they are in common file formats.
- Response Time: We aim to respond to all emails within 7-10 business days. Complex inquiries may require additional time.
- Follow-ups: If you haven't received a response after 10 business days, feel free to send a polite follow-up.
- Response Time: We aim to respond to all emails within 2 business days. Complex inquiries may require additional time.
- Follow-ups: If you haven't received a response after 3 business days, feel free to send a polite follow-up.
### 5.14. Email Privacy and Security
@@ -469,34 +413,7 @@ By sending a direct message, you acknowledge that you have read and agreed to th
**IMPORTANT: While we value direct communication, we strongly encourage the use of our public channels whenever possible to foster community engagement and shared learning. Direct messages are the lowest priority communication channel and may experience significant response delays.**
## 7. RESPONSE TIME GUIDELINES
### 7.1. Standard Response Times
All inquiries and communications are handled with a standard response time of **7-10 business days**. This applies to:
- General inquiries and questions
- Support requests
- Policy clarification requests
- Programme-related inquiries
- Technical support requests
- Security reports
- Content reports and moderation appeals
- All other communications
### 7.2. Business Days Definition
Business days are defined as Monday through Friday, excluding weekends and holidays. Response times are calculated from the time your message is received during business hours.
### 7.3. Complex Inquiries
Complex inquiries may require additional time beyond the standard 7-10 business days. In such cases, we will acknowledge your inquiry within the standard timeframe and provide an estimated completion date.
### 7.4. Follow-Up Communications
If you have not received a response after 10 business days, you may send a polite follow-up. Please avoid sending multiple follow-ups at shorter intervals, as this may delay response processing.
## 8. LIMITATION OF LIABILITY AND DISCLAIMERS
## 7. LIMITATION OF LIABILITY AND DISCLAIMERS
### 7.1. Reference to Comprehensive Liability Framework
@@ -520,7 +437,7 @@ For general inquiries about this Policy or our communication channels:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for general inquiries
**Response Time:** Within 48 hours for general inquiries
### 8.2. Policy Questions
src/content/docs/about/development-reviews.md
+27 -9
View File
@@ -8,7 +8,7 @@ title: Development Review Policy
### 1.1. Policy Overview
This Development Review Policy ("Policy") establishes the terms, conditions, and procedures governing requests for code reviews, project planning consultations, and technical writing reviews from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Development Review Policy ("Policy") establishes the terms, conditions, and procedures governing requests for code reviews, project planning consultations, and technical writing reviews from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Service Availability and Eligibility
@@ -33,8 +33,8 @@ This Policy applies to:
**Code Review Services:**
**(a)** Review of specific code submissions, pull requests, or codebase sections;
**(b)** Feedback on code quality, best practices, and potential improvements;
**(c)** Suggestions for code organisation, structure, and maintainability;
**(d)** Recommendations for performance optimisation, security considerations, and testing;
**(c)** Suggestions for code organization, structure, and maintainability;
**(d)** Recommendations for performance optimization, security considerations, and testing;
**(e)** Code reviews are provided based on industry best practices and professional standards;
**(f)** We reserve the right to decline code reviews if code is incomplete, inaccessible, or exceeds reasonable scope;
**(g)** Code reviews focus on specific, bounded submissions rather than entire codebases.
@@ -56,7 +56,7 @@ This Policy applies to:
**Technical Writing Review Services:**
**(a)** Review of technical blog posts, articles, documentation, README files, or other technical writing;
**(b)** Feedback on clarity, structure, technical accuracy, and audience appropriateness;
**(c)** Suggestions for improving readability, organisation, and presentation of technical content;
**(c)** Suggestions for improving readability, organization, and presentation of technical content;
**(d)** Recommendations for formatting, code examples, and visual aids;
**(e)** Technical writing reviews are provided based on technical communication best practices and professional standards;
**(f)** We reserve the right to decline technical writing reviews if content is incomplete, inaccessible, or exceeds reasonable scope;
@@ -80,7 +80,25 @@ This Policy applies to:
**IMPORTANT: Development reviews are FREE services provided EXCLUSIVELY to active members of our community. These services are NOT available to the general public or individuals who are not actively engaged in our community.**
For comprehensive eligibility requirements, eligibility criteria, and information about becoming an active community member, please refer to our [Community Membership Eligibility Policy](/about/community-membership-eligibility).
**Eligibility Criteria:**
**(a)** **REQUIRED**: Requesters MUST be active, engaged members of our community with demonstrated participation, such as:
**(i)** Active participation in our mentorship programme;
**(ii)** Regular, ongoing community engagement in our Discord server or other community platforms;
**(iii)** Active volunteer work or contribution to community projects;
**(iv)** Sustained, meaningful interaction demonstrating active community membership;
**(b)** We will verify community membership and activity before accepting any development review request;
**(c)** We reserve the right to decline requests from individuals who are not active community members, regardless of other factors;
**(d)** Casual or minimal community interaction does NOT qualify as active membership;
**(e)** We will not provide development reviews for individuals we have not directly interacted with or who lack active community connection;
**(f)** Priority may be given to individuals from underrepresented groups in technology who are active community members.
**Not an Active Community Member?**
If you are not currently an active member of our community but are interested in accessing development review services, we encourage you to join our Discord community and become an active participant. Active community membership involves regular engagement, participation in discussions, and meaningful contribution to our community.
**Join our Discord community:** [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
Once you have established active community membership through regular participation and engagement, you will be eligible to request development review services. We look forward to welcoming you to our community!
### 3.2. Request Information Requirements
@@ -181,9 +199,9 @@ For comprehensive eligibility requirements, eligibility criteria, and informatio
**Request Frequency:**
**(a)** We may limit the number of development reviews provided to the same requester within a specified time period;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritised at our discretion;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritized at our discretion;
**(c)** We reserve the right to decline requests if we determine development review provision would be excessive or burdensome;
**(d)** Requesters should coordinate multiple review needs to minimise burden and ensure timely completion;
**(d)** Requesters should coordinate multiple review needs to minimize burden and ensure timely completion;
**(e)** Updated materials may be submitted for re-review after implementing previous feedback.
### 6.3. Scope Limitations
@@ -250,7 +268,7 @@ For questions about this Policy or development review requests:
**Subject Line:** Development Review Policy Inquiry - [Brief Description]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for Policy-related inquiries
### 9.2. Request Status Inquiries
@@ -260,7 +278,7 @@ For questions about the status of submitted development review requests:
**Subject Line:** Development Review Request Status - [Your Name]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for status inquiries
### 9.3. General Contact
src/content/docs/about/donate.md
+2 -2
View File
@@ -8,7 +8,7 @@ title: Donation and Support Policy
### 1.1. Policy Overview
This Donation and Support Policy ("Policy") establishes the terms, conditions, and procedures governing voluntary financial contributions and other forms of support to NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Donation and Support Policy ("Policy") establishes the terms, conditions, and procedures governing voluntary financial contributions and other forms of support to NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Legal Framework Integration
@@ -212,7 +212,7 @@ For questions about donations or support options:
**Email:** donors@nhcarrigan.com
**Response Time:** Within 7-10 business days for donation-related inquiries
**Response Time:** Within 48 hours for donation-related inquiries
### 9.2. General Contact
src/content/docs/about/hire.md
+2 -2
View File
@@ -8,7 +8,7 @@ title: Professional Services and Commission Policy
### 1.1. Policy Overview
This Professional Services and Commission Policy ("Policy") establishes the terms, conditions, and procedures governing professional services, consulting engagements, and commission-based work provided by NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Professional Services and Commission Policy ("Policy") establishes the terms, conditions, and procedures governing professional services, consulting engagements, and commission-based work provided by NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Legal Framework Integration
@@ -235,7 +235,7 @@ For inquiries about professional services or to submit commission requests:
**Email:** contact@nhcarrigan.com
**Response Time:** Within 7-10 business days for service inquiries
**Response Time:** Within 48 hours for service inquiries
### 11.2. General Contact
src/content/docs/about/mentorship.md
+2 -12
View File
@@ -81,17 +81,7 @@ By enrolling in the Programme, Mentees acknowledge and agree that they have:
**(d)** Additional resources and Programme updates are provided as part of programme participation;
**(e)** We reserve the right to modify or discontinue specific resources or support services with reasonable notice.
### 3.5. Self-Guided Programme Structure
**Programme Philosophy:**
**(a)** The programme is designed to be self-guided and self-managed;
**(b)** Participants work at their own pace with no mandatory deadlines or review requirements;
**(c)** Comprehensive documentation, templates, and resources are provided to support independent learning;
**(d)** Reviews, approvals, and support are optional and available upon request, not guaranteed;
**(e)** Programme leadership and mentors are not monitoring every participant action or progress;
**(f)** **IMPORTANT: To get the most value from the programme experience, participants should actively ask mentors questions as much as possible. Mentors are available to help, but they rely on participants to initiate contact and ask for assistance when needed.**
### 3.6. Service Limitations and Disclaimers
### 3.5. Service Limitations and Disclaimers
**IMPORTANT DISCLAIMERS:**
**(a)** Programme services and resources are provided "as is" without warranties of any kind;
@@ -241,7 +231,7 @@ For questions about the Programme or to submit cancellation notices:
**Email:** contact@nhcarrigan.com
**Response Time:** Within 7-10 business days for Programme-related inquiries
**Response Time:** Within 48 hours for Programme-related inquiries
### 11.2. General Contact
src/content/docs/about/mission.md
+2 -2
View File
@@ -2,7 +2,7 @@
title: Mission Statement
---
This Mission Statement ("Statement") articulates the core values and guiding principles of NHCarrigan ("The Company") in its efforts to build inclusive, ethical, and sustainable technology solutions and foster welcoming online communities. This Statement operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Mission Statement ("Statement") articulates the core values and guiding principles of NHCarrigan ("The Company") in its efforts to build inclusive, ethical, and sustainable technology solutions and foster welcoming online communities. This Statement operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Policies, and all applicable legal protections by reference.
## 1. Core Values
@@ -30,7 +30,7 @@ Our projects are community-centric, encouraging collaboration and input from div
The Company is committed to tearing down the systemic and social barriers that exist in the tech industry. We actively work to make the field more accessible to individuals from all backgrounds, particularly those who have historically been excluded.
### 1.7. Challenging Toxic Behaviours
### 1.7. Challenging Toxic Behaviors
We recognise that toxic behaviours and exclusionary practices harm communities. The Company shall take a proactive stance in challenging these behaviours within our industry and within the tech communities we interact with, fostering spaces where collaboration, respect, and growth thrive.
src/content/docs/about/mock-interviews.md
+23 -5
View File
@@ -8,7 +8,7 @@ title: Mock Interview Policy
### 1.1. Policy Overview
This Mock Interview Policy ("Policy") establishes the terms, conditions, and procedures governing requests for mock interviews and interview preparation sessions from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Mock Interview Policy ("Policy") establishes the terms, conditions, and procedures governing requests for mock interviews and interview preparation sessions from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Service Availability and Eligibility
@@ -76,7 +76,25 @@ This Policy applies to:
**IMPORTANT: Mock interviews are FREE services provided EXCLUSIVELY to active members of our community. These services are NOT available to the general public or individuals who are not actively engaged in our community.**
For comprehensive eligibility requirements, eligibility criteria, and information about becoming an active community member, please refer to our [Community Membership Eligibility Policy](/about/community-membership-eligibility).
**Eligibility Criteria:**
**(a)** **REQUIRED**: Requesters MUST be active, engaged members of our community with demonstrated participation, such as:
**(i)** Active participation in our mentorship programme;
**(ii)** Regular, ongoing community engagement in our Discord server or other community platforms;
**(iii)** Active volunteer work or contribution to community projects;
**(iv)** Sustained, meaningful interaction demonstrating active community membership;
**(b)** We will verify community membership and activity before accepting any mock interview request;
**(c)** We reserve the right to decline requests from individuals who are not active community members, regardless of other factors;
**(d)** Casual or minimal community interaction does NOT qualify as active membership;
**(e)** We will not provide mock interviews for individuals we have not directly interacted with or who lack active community connection;
**(f)** Priority may be given to individuals from underrepresented groups in technology who are active community members.
**Not an Active Community Member?**
If you are not currently an active member of our community but are interested in accessing mock interview services, we encourage you to join our Discord community and become an active participant. Active community membership involves regular engagement, participation in discussions, and meaningful contribution to our community.
**Join our Discord community:** [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
Once you have established active community membership through regular participation and engagement, you will be eligible to request mock interview services. We look forward to welcoming you to our community!
### 3.2. Request Information Requirements
@@ -190,7 +208,7 @@ For comprehensive eligibility requirements, eligibility criteria, and informatio
**(a)** We may limit the number of mock interviews provided to the same requester within a specified time period;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritized at our discretion;
**(c)** We reserve the right to decline requests if we determine mock interview provision would be excessive or burdensome;
**(d)** Requesters should coordinate multiple interview preparation needs to minimise burden and ensure timely scheduling;
**(d)** Requesters should coordinate multiple interview preparation needs to minimize burden and ensure timely scheduling;
**(e)** Follow-up mock interviews may be available after implementing previous feedback and additional preparation.
### 6.3. Prohibited Uses
@@ -248,7 +266,7 @@ For questions about this Policy or mock interview requests:
**Subject Line:** Mock Interview Policy Inquiry - [Brief Description]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for Policy-related inquiries
### 9.2. Request Status Inquiries
@@ -258,7 +276,7 @@ For questions about the status of submitted mock interview requests:
**Subject Line:** Mock Interview Request Status - [Your Name]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for status inquiries
### 9.3. General Contact
src/content/docs/about/portfolio-reviews.md
+29 -11
View File
@@ -8,7 +8,7 @@ title: Portfolio Review Policy
### 1.1. Policy Overview
This Portfolio Review Policy ("Policy") establishes the terms, conditions, and procedures governing requests for reviews of resumes, LinkedIn profiles, GitHub profiles, portfolios, and related professional materials from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Portfolio Review Policy ("Policy") establishes the terms, conditions, and procedures governing requests for reviews of resumes, LinkedIn profiles, GitHub profiles, portfolios, and related professional materials from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Service Availability and Eligibility
@@ -22,7 +22,7 @@ This Portfolio Review Policy ("Policy") establishes the terms, conditions, and p
This Policy applies to:
**(a)** All requests for resume reviews and feedback;
**(b)** All requests for LinkedIn profile reviews and optimisation suggestions;
**(b)** All requests for LinkedIn profile reviews and optimization suggestions;
**(c)** All requests for GitHub profile reviews and improvement recommendations;
**(d)** All requests for portfolio website reviews and feedback;
**(e)** All requests for related professional profile materials reviews;
@@ -34,7 +34,7 @@ This Policy applies to:
**Resume Review Services:**
**(a)** Comprehensive review of resume content, formatting, and structure;
**(b)** Feedback on technical skills presentation and organisation;
**(b)** Feedback on technical skills presentation and organization;
**(c)** Suggestions for improving clarity, impact, and ATS (Applicant Tracking System) compatibility;
**(d)** Recommendations for highlighting relevant experience and projects;
**(e)** Resume reviews are provided based on industry best practices and professional standards;
@@ -43,7 +43,7 @@ This Policy applies to:
### 2.2. LinkedIn Profile Reviews
**LinkedIn Profile Review Services:**
**(a)** Review of LinkedIn profile completeness and optimisation;
**(a)** Review of LinkedIn profile completeness and optimization;
**(b)** Feedback on headline, summary, and experience sections;
**(c)** Suggestions for improving profile visibility and professional branding;
**(d)** Recommendations for skills, endorsements, and recommendations;
@@ -54,9 +54,9 @@ This Policy applies to:
**GitHub Profile Review Services:**
**(a)** Review of GitHub profile README and pinned repositories;
**(b)** Feedback on repository organisation and documentation quality;
**(b)** Feedback on repository organization and documentation quality;
**(c)** Suggestions for improving contribution graph visibility and project presentation;
**(d)** Recommendations for profile optimisation and professional presentation;
**(d)** Recommendations for profile optimization and professional presentation;
**(e)** GitHub reviews are provided based on open source and developer community best practices;
**(f)** We reserve the right to decline GitHub reviews if profiles are private or inaccessible.
@@ -87,7 +87,25 @@ This Policy applies to:
**IMPORTANT: Portfolio reviews are FREE services provided EXCLUSIVELY to active members of our community. These services are NOT available to the general public or individuals who are not actively engaged in our community.**
For comprehensive eligibility requirements, eligibility criteria, and information about becoming an active community member, please refer to our [Community Membership Eligibility Policy](/about/community-membership-eligibility).
**Eligibility Criteria:**
**(a)** **REQUIRED**: Requesters MUST be active, engaged members of our community with demonstrated participation, such as:
**(i)** Active participation in our mentorship programme;
**(ii)** Regular, ongoing community engagement in our Discord server or other community platforms;
**(iii)** Active volunteer work or contribution to community projects;
**(iv)** Sustained, meaningful interaction demonstrating active community membership;
**(b)** We will verify community membership and activity before accepting any review request;
**(c)** We reserve the right to decline requests from individuals who are not active community members, regardless of other factors;
**(d)** Casual or minimal community interaction does NOT qualify as active membership;
**(e)** We will not provide reviews for individuals we have not directly interacted with or who lack active community connection;
**(f)** Priority may be given to individuals from underrepresented groups in technology who are active community members.
**Not an Active Community Member?**
If you are not currently an active member of our community but are interested in accessing portfolio review services, we encourage you to join our Discord community and become an active participant. Active community membership involves regular engagement, participation in discussions, and meaningful contribution to our community.
**Join our Discord community:** [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
Once you have established active community membership through regular participation and engagement, you will be eligible to request portfolio review services. We look forward to welcoming you to our community!
### 3.2. Request Information Requirements
@@ -191,9 +209,9 @@ For comprehensive eligibility requirements, eligibility criteria, and informatio
**Request Frequency:**
**(a)** We may limit the number of reviews provided to the same requester within a specified time period;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritised at our discretion;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritized at our discretion;
**(c)** We reserve the right to decline requests if we determine review provision would be excessive or burdensome;
**(d)** Requesters should coordinate multiple review needs to minimise burden and ensure timely completion;
**(d)** Requesters should coordinate multiple review needs to minimize burden and ensure timely completion;
**(e)** Updated materials may be submitted for re-review after implementing previous feedback.
### 6.3. Prohibited Uses
@@ -250,7 +268,7 @@ For questions about this Policy or portfolio review requests:
**Subject Line:** Portfolio Review Policy Inquiry - [Brief Description]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for Policy-related inquiries
### 9.2. Request Status Inquiries
@@ -260,7 +278,7 @@ For questions about the status of submitted portfolio review requests:
**Subject Line:** Portfolio Review Request Status - [Your Name]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for status inquiries
### 9.3. General Contact
src/content/docs/about/recommendations.md
+23 -5
View File
@@ -8,7 +8,7 @@ title: Letter of Recommendation and Character Reference Policy
### 1.1. Policy Overview
This Letter of Recommendation and Character Reference Policy ("Policy") establishes the terms, conditions, and procedures governing requests for letters of recommendation and character references from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference.
This Letter of Recommendation and Character Reference Policy ("Policy") establishes the terms, conditions, and procedures governing requests for letters of recommendation and character references from NHCarrigan ("we," "us," "our," or "the Company"). This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Service Availability and Eligibility
@@ -68,7 +68,25 @@ This Policy applies to:
**IMPORTANT: Letters of recommendation and character references are FREE services provided EXCLUSIVELY to active members of our community. These services are NOT available to the general public or individuals who are not actively engaged in our community.**
For comprehensive eligibility requirements, eligibility criteria, and information about becoming an active community member, please refer to our [Community Membership Eligibility Policy](/about/community-membership-eligibility).
**Eligibility Criteria:**
**(a)** **REQUIRED**: Requesters MUST be active, engaged members of our community with demonstrated participation, such as:
**(i)** Active participation in our mentorship programme;
**(ii)** Regular, ongoing community engagement in our Discord server or other community platforms;
**(iii)** Active volunteer work or contribution to community projects;
**(iv)** Sustained, meaningful interaction demonstrating active community membership;
**(v)** Professional collaboration or work relationship within our community context;
**(b)** We will verify community membership and activity before accepting any recommendation request;
**(c)** We reserve the right to decline requests from individuals who are not active community members, regardless of other factors;
**(d)** Casual acquaintanceship or minimal interaction does NOT qualify as active membership;
**(e)** We will not provide recommendations for individuals we have not directly interacted with or who lack active community connection.
**Not an Active Community Member?**
If you are not currently an active member of our community but are interested in accessing recommendation services, we encourage you to join our Discord community and become an active participant. Active community membership involves regular engagement, participation in discussions, and meaningful contribution to our community.
**Join our Discord community:** [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
Once you have established active community membership through regular participation and engagement, you will be eligible to request recommendation services. We look forward to welcoming you to our community!
### 3.2. Request Information Requirements
@@ -164,7 +182,7 @@ For comprehensive eligibility requirements, eligibility criteria, and informatio
**(a)** We may limit the number of recommendations provided to the same requester within a specified time period;
**(b)** Multiple simultaneous requests from the same requester may be consolidated or prioritized at our discretion;
**(c)** We reserve the right to decline requests if we determine recommendation provision would be excessive or burdensome;
**(d)** Requesters should coordinate multiple recommendation needs to minimise burden and ensure timely completion.
**(d)** Requesters should coordinate multiple recommendation needs to minimize burden and ensure timely completion.
### 6.3. Prohibited Uses
@@ -219,7 +237,7 @@ For questions about this Policy or recommendation requests:
**Subject Line:** Recommendation Policy Inquiry - [Brief Description]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for Policy-related inquiries
### 9.2. Request Status Inquiries
@@ -229,7 +247,7 @@ For questions about the status of submitted recommendation requests:
**Subject Line:** Recommendation Request Status - [Your Name]
**Response Time:** See our [Contact Policy](/about/contact) for response time expectations.
**Response Time:** Within 48 hours for status inquiries
### 9.3. General Contact
src/content/docs/about/sustainability.md
-6
View File
@@ -62,12 +62,6 @@ The Company reserves the right to refuse any project or contract that it determi
### 4.3. Continuous Monitoring
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
The Company shall continuously monitor the environmental impact of its ongoing operations and projects, making adjustments as necessary to remain aligned with its sustainability goals.
## 5. Legal and Ethical Compliance
src/content/docs/community/coc.md
+17 -5
View File
@@ -19,7 +19,19 @@ Our community is built upon the following core principles:
### 1.3. Legal Framework and Policy Integration
This Code operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Acceptable Use Policy, Content and Moderation Policy, Limitation of Liability and Indemnification Policy, and all applicable legal protections by reference.
This Code operates within and supplements our comprehensive legal and policy framework, including:
**(a)** **Terms of Service**: Fundamental legal relationship and user obligations;
**(b)** **Acceptable Use Policy**: Detailed prohibited activities and usage restrictions;
**(c)** **Content and Moderation Policy**: Comprehensive content standards and moderation procedures;
**(d)** **Privacy Policy**: Data protection and privacy rights;
**(e)** **Limitation of Liability and Indemnification Policy**: Legal protections and risk allocation;
**(f)** **All other applicable legal policies**: Export control, service level agreements, and specialised policies.
**IMPORTANT**: Where this Code overlaps with our comprehensive legal policies, users are subject to both sets of requirements. For detailed enforcement procedures, content moderation standards, and legal protections, refer to the applicable specialised policies incorporated by reference.
@@ -217,10 +229,10 @@ Community Members are required to:
#### 5.1.1. Available Reporting Methods
Community Members can report Code of Conduct violations through the following channels:
- **Incident Report Form** (Preferred): Submit reports through our official Incident Report Form: https://forms.nhcarrigan.com/o/docs/forms/t7CYeYS4uyUuLiKFatoEvs/4
- **Discord Reporting**: Type `@Moderator` in any channel to alert Community Leaders
- **Direct Communication**: Contact any Community Leader through private messages
- **Email Contact**: Submit reports to contact@nhcarrigan.com
- **Anonymous Reporting**: Use designated anonymous reporting forms where available
#### 5.1.2. Information to Include in Reports
Effective reports should include:
@@ -236,11 +248,11 @@ Effective reports should include:
#### 5.2.1. Initial Response Protocol
Upon receiving a report, Community Leaders will:
- Acknowledge receipt within 7-10 business days when possible
- Acknowledge receipt within 24 hours when possible
- Conduct an initial assessment of the report's severity and scope
- Take immediate protective measures if necessary to ensure community safety
- Recuse any Community Leaders who have conflicts of interest in the matter
- Begin formal investigation procedures within 7-10 business days
- Begin formal investigation procedures within 72 hours
#### 5.2.2. Investigation Standards
All investigations will adhere to the following standards:
@@ -522,7 +534,7 @@ Violations of advertising and promotion restrictions will be addressed through:
#### 9.1.1. English as Primary Language
The official language of Our Community is English, and all community interactions, discussions, and contributions should be conducted in English to ensure:
- Clear communication amongst all community members
- Clear communication among all community members
- Effective moderation and community management
- Consistency across all community platforms and activities
- Accessibility for the broadest range of community members
src/content/docs/community/fan-art.md
-186
View File
@@ -1,186 +0,0 @@
---
title: Fan Art Guidelines
---
## 1. Introduction and Purpose
### 1.1. Welcome to Our Fan Art Community!
Are you interested in creating art for our lovely Naomi? We absolutely love seeing creative interpretations of our characters and would be thrilled to feature your work! These guidelines will help you understand what we're looking for and how to submit your creations.
### 1.2. Scope
These guidelines apply to:
- Fan art of Naomi and her various designs
- Fan art of Original Characters (OCs) shared in our #characters channel (Naomi's OCs)
- Any artistic interpretations of our characters and community
## 2. Content Guidelines
### 2.1. Content Standards
#### 2.1.1. Family-Friendly Public Submissions
For art that will be shared in our public spaces (such as our fan art channel), we maintain family-friendly standards:
**(a)** **No Obscene or NSFW Content**: Public submissions must be appropriate for all audiences. We want to show your work off to everyone!
**(b)** **Original Works Only**: Please no AI-generated content. We want to see your original works! If Naomi wanted AI-generated art, she would generate it herself.
**(c)** **Creative Freedom**: You are free to give Naomi whatever outfit you would like. Refer to our reference channel for reference images to get an idea of her style.
#### 2.1.2. NSFW Content Policy
We understand that some artists may wish to create mature content featuring our characters. We have the following policy for such works:
**(a)** **DM Submission Required**: NSFW works must be sent to us via direct message (DM) only. Do not post NSFW content in any public channels.
**(b)** **Private Appreciation**: While we appreciate all artistic interpretations, NSFW works will not be shared in our public spaces as we are a family-friendly community.
**(c)** **Respectful Content**: Even for private submissions, we reserve the right to decline content that we find inappropriate or that violates our community standards.
**(d)** **Recognition**: Accepted NSFW submissions will still qualify for the role!
### 2.2. Original Characters (OCs)
We have a dedicated **#characters** channel where Naomi shares her Original Characters! You are welcome and encouraged to create fan art of these OCs as well. When creating art of Naomi's OCs:
**(a)** **Respect Character Design**: Please respect the original character designs and creator intentions.
**(b)** **Follow Same Guidelines**: All content guidelines (family-friendly for public, NSFW via DM only) apply to OC fan art as well.
## 3. Reference Materials and Resources
### 3.1. Available Reference Materials
#### 3.1.1. Reference Images
We maintain reference images in our Discord reference channel. These images can help you understand Naomi's style, color palette, and design elements.
### 3.2. Important Disclaimer About Reference Materials
:::warning[AI-Generated Reference Materials Disclaimer]
**Please be aware that our current reference sheets and other visual assets are AI-generated. This is a temporary situation.**
We operate at a significant loss and do not currently have the budget to commission proper, human-created art for all of our reference materials. However, we are committed to replacing these AI-generated assets with proper commissioned art as funds become available.
**How You Can Help:**
- **Financial Support**: If you would like to help us replace our AI-generated assets with proper art, you can donate at [donate.nhcarrigan.com](https://donate.nhcarrigan.com). All donations help us work toward commissioning proper reference art.
- **Art Donations**: We would be absolutely thrilled to accept donated art to replace our AI-generated assets! If you're interested in creating reference art or other assets for us, please reach out via DM to discuss.
We appreciate your understanding and patience as we work to improve our resources. Our goal is to have all human-created, properly commissioned art, and we're working toward that goal every day.
:::
## 4. Submission Process
### 4.1. How to Submit Your Art
#### 4.1.1. Public Submissions (Family-Friendly Content)
To submit family-friendly fan art for public sharing:
1. **Create Your Art**: Follow the guidelines above to ensure your work meets our standards.
2. **DM Your Submission**: Send your artwork to Naomi directly via DM.
3. **Review Process**: If accepted, your art will be shared in our fan art channel (with full credit - you will be tagged in the post).
4. **Recognition**: Accepted submissions will receive a special role recognizing your contribution!
#### 4.1.2. Private Submissions (NSFW Content)
For NSFW works:
1. **DM Only**: Send your NSFW artwork directly to Naomi via DM.
2. **Private Appreciation**: These works will be appreciated privately and will not be shared in public spaces.
3. **No Public Sharing**: Please do not post NSFW content in any public channels, even if you think it might be acceptable.
4. **Recognition**: Accepted submissions will still qualify for the role!
### 4.2. What Happens After Submission
#### 4.2.1. Review Timeline
We review submissions as quickly as possible, but please be patient. We want to give each piece the attention it deserves!
#### 4.2.2. Acceptance and Sharing
If your public submission is accepted:
- Your art will be posted in our fan art channel
- You will be tagged and credited in the post
- You will receive a special role recognizing your contribution
- We may share your work on other platforms (with credit)
#### 4.2.3. If Your Submission Isn't Accepted
If we decline a submission, we'll do our best to explain why. Common reasons include:
- Content doesn't meet our family-friendly standards (for public submissions)
- Quality concerns (though we appreciate all skill levels!)
- Copyright or intellectual property issues
- Other community guideline violations
We're always happy to provide feedback and work with artists to create content that fits our community!
## 5. Rights and Permissions
### 5.1. Artist Rights and Rights Transfer
**(a)** **Rights Transfer**: By submitting your art to us, you transfer the rights to your creation to us. This transfer occurs upon submission and acceptance of your work.
**(b)** **Credit Always Given**: We will always credit you when sharing your work, even though rights have been transferred.
**(c)** **Usage Rights**: Once rights are transferred, we have the right to use, display, share, and distribute your submitted artwork in our community spaces and on other platforms with proper credit.
### 5.2. Character Rights
**(a)** **Character Ownership**: Naomi and other official characters remain the property of NHCarrigan.
**(b)** **Fan Art Rights**: Creating fan art is generally considered fair use, but please be respectful of the characters and community.
**(c)** **Commercial Use**: If you're interested in commercial use of our characters, please contact us to discuss licensing.
## 6. Community Support and Appreciation
### 6.1. We Love Your Art!
We genuinely appreciate every piece of art created for our community. Whether it's a quick sketch or a detailed masterpiece, your creativity and effort mean the world to us!
### 6.2. Growing Together
We're always working to improve our resources and support for artists. As we grow and develop better reference materials (see our disclaimer above), we hope to make it even easier for artists to create amazing fan art!
### 6.3. Questions or Concerns?
If you have any questions about these guidelines, the submission process, or anything else related to fan art, please don't hesitate to reach out via DM or ask in our community channels!
---
## Summary: Quick Reference
**✅ DO:**
- Create original, family-friendly art for public sharing
- DM your submissions to Naomi
- Feel free to be creative with outfits and styles
- Create art of Naomi's OCs from our #characters channel
- Send NSFW works via DM only (they won't be shared publicly)
**❌ DON'T:**
- Submit AI-generated content
- Post NSFW content in public channels
- Disrespect character designs when making OC fan art
- Submit content that violates our community standards
**📝 Remember:**
- Reference materials are currently AI-generated (temporary!)
- You can help us get proper art by donating or creating art donations
- By submitting art, you transfer rights to your creation to us
- We always credit artists when sharing their work
- Questions? Just ask!
---
*Thank you for your interest in creating art for our community! We can't wait to see what you create!*
src/content/docs/community/feedback.md
+9 -50
View File
@@ -35,7 +35,7 @@ We believe that community members are the ultimate experts on their own experien
### 1.4. Legal Framework Integration
This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Community Leadership and Governance Policy, and all applicable legal protections by reference.
This Policy operates within our comprehensive legal and policy framework, including our Terms of Service, Privacy Policy, Community Code of Conduct, and Community Leadership and Governance Policy, all of which are incorporated herein by reference.
## 2. Feedback Channels and Communication Systems
@@ -44,10 +44,10 @@ This Policy operates within our comprehensive legal and policy framework, incorp
#### 2.1.1. Daily and Ongoing Feedback Channels
**Open Communication Channels:**
- Dedicated feedback forum categories accessible to all community members for ongoing input and suggestions
- Community: [Community Feedback](https://support.nhcarrigan.com/c/community-feedback/8) category on our support forum
- Products: [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) or [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) categories on our support forum
- Policies: [Policy Ideation](https://support.nhcarrigan.com/c/policy-ideation/9) category on our support forum
- Dedicated feedback forum channels accessible to all community members for ongoing input and suggestions
- Community: `#community-feedback` forum channel on Discord
- Products: `#bug-reports` or `#feature-requests` forum channel on Discord
- Policies: `#policy-ideation` forum channel on Discord
- Direct messaging opportunities with community leadership for individual concerns and suggestions
- Public discussion forums for community-wide conversation about policies and improvements
@@ -60,12 +60,6 @@ This Policy operates within our comprehensive legal and policy framework, incorp
#### 2.1.2. Scheduled Feedback Collection
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
**Monthly Community Input Sessions:**
- Structured community meetings focused on specific policy areas or community improvements
- Rotating focus areas ensuring comprehensive coverage of community operations and policies
@@ -214,7 +208,7 @@ When immediate policy changes are necessary for community safety:
- **Regular policy effectiveness surveys** gathering community input on how well policies are meeting their intended objectives
- **Community impact assessment** evaluating policy effects on different community groups and addressing unintended consequences
- **Policy modification processes** incorporating community feedback and assessment results into ongoing policy improvement
- **Community success metrics** developed collaboratively to measure progress towards shared community goals and values
- **Community success metrics** developed collaboratively to measure progress toward shared community goals and values
## 5. Special Consultation and Participation Programs
@@ -228,7 +222,7 @@ When immediate policy changes are necessary for community safety:
- **Cultural competency** in consultation design and facilitation to encourage authentic participation from diverse community members
- **Language and accessibility support** removing barriers to participation for community members with diverse needs
**Specialised Advisory Groups:**
**Specialized Advisory Groups:**
- **Rotating advisory panels** including community members from diverse backgrounds and experience levels
- **Issue-specific consultation groups** bringing together community members with relevant expertise or lived experience
- **Accessibility advisory groups** providing ongoing input on inclusion and accommodation needs and improvements
@@ -242,41 +236,12 @@ When immediate policy changes are necessary for community safety:
- **Peer review and community refinement** processes helping improve community-driven proposals through collaborative development
- **Implementation support** for community-approved initiatives including resource allocation and ongoing assistance
**Community Organising and Advocacy:**
**Community Organizing and Advocacy:**
- **Community organising support** for members who want to advocate for specific changes or improvements
- **Coalition building assistance** helping community members with shared interests collaborate effectively on improvement initiatives
- **Advocacy training and resources** empowering community members to effectively participate in governance and change processes
- **Community campaign support** for democratic initiatives that build broad community support for positive changes
#### 5.1.3. Demographic Self-Identification
**Voluntary Self-Identification Process:**
- **Anonymous demographic self-identification form** enabling community members to voluntarily share demographic information to help us understand community diversity and identify participation barriers
- **New member onboarding requirement** all new community members are encouraged to complete the self-identification form when joining the community
- **Annual demographic update** all community members are encouraged to complete the self-identification form at the start of each calendar year to measure demographic trends and changes over time
- **Complete anonymity** all responses are completely anonymous and aggregated for statistical analysis only; individual responses cannot be linked to specific community members
**Purpose and Use:**
- **Demographic diversity assessment** understanding the diversity of our community across various dimensions including age, geographic location, language, gender identity, sexual orientation, race/ethnicity, disability status, neurodivergence, and socioeconomic background
- **Participation barrier identification** identifying barriers to engagement affecting different demographic groups
- **Feedback system evaluation** ensuring feedback systems and participation opportunities effectively reach and engage diverse community members
- **Accessibility improvement** measuring progress toward inclusive representation and identifying areas where accessibility and accommodation efforts need enhancement
- **Trend measurement** tracking demographic changes and trends over time to understand community evolution
**Privacy and Confidentiality:**
- **Complete anonymity** no identifying information is collected; responses cannot be linked to individual community members
- **Aggregated analysis only** all data is used only in aggregate form for statistical analysis and community improvement purposes
- **Voluntary participation** participation is completely voluntary; all questions include a "Prefer not to answer" option
- **Secure data handling** all demographic data is stored securely and handled in accordance with our Privacy Policy and applicable data protection laws
**Self-Identification Form:**
Community members can complete the anonymous self-identification form at: https://forms.nhcarrigan.com/o/docs/forms/p7fkz5yJN9GKrQjw5zhX6U/4
**Completion Requirements:**
- **New members:** All new community members are encouraged to complete the self-identification form as part of the onboarding process
- **Annual updates:** All community members are encouraged to complete the self-identification form at the start of each calendar year (January) to help us measure demographic trends and changes over time
- **Voluntary nature:** While completion is encouraged, participation remains completely voluntary and anonymous
### 5.2. Crisis and Emergency Community Consultation
#### 5.2.1. Emergency Response Input
@@ -302,7 +267,7 @@ Community members can complete the anonymous self-identification form at: https:
#### 6.1.1. Individual Feedback Acknowledgment
**Personal Response Commitments:**
- **Acknowledgment within 7-10 business days** for all individual feedback submissions and policy input
- **Acknowledgment within 48 hours** for all individual feedback submissions and policy input
- **Detailed responses within 14 days** addressing specific concerns, suggestions, and questions raised by community members
- **Follow-up communication** ensuring community members feel heard and providing updates on how their input is being considered
- **Personal consultation opportunities** for community members who need additional discussion or clarification about their feedback
@@ -315,12 +280,6 @@ Community members can complete the anonymous self-identification form at: https:
#### 6.1.2. Community-Wide Response Communication
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
**Public Feedback Summaries:**
- **Monthly summary reports** highlighting community feedback themes, concerns, and suggestions received
- **Response action reports** detailing how community feedback has influenced policies, decisions, and community improvements
src/content/docs/community/guide.md
+8 -8
View File
@@ -614,7 +614,7 @@ When platform features allow:
#### 7.5.1. Respectful Responses to Warnings
Community members should demonstrate respect for content warning practices by:
- **Taking Warnings Seriously**: Never mock, dismiss, or minimise the importance of content warnings
- **Individual Needs Recognition**: Understanding that warning needs vary amongst individuals
- **Individual Needs Recognition**: Understanding that warning needs vary among individuals
- **Gracious Compliance**: Accepting requests for additional warnings without defensiveness
- **Supportive Behaviour**: Encouraging and normalising content warning usage
@@ -645,7 +645,7 @@ Conflicts, disagreements, and differences of opinion represent natural and inevi
#### 8.1.2. Restorative Justice Principles
Our conflict resolution approach emphasises:
- **Relationship Repair**: Focus on healing and strengthening community relationships
- **Mutual Understanding**: Encouraging empathy and perspective-taking amongst conflicting parties
- **Mutual Understanding**: Encouraging empathy and perspective-taking among conflicting parties
- **Learning Opportunities**: Using conflicts as chances for personal and community growth
- **Collaborative Solutions**: Seeking win-win outcomes that address underlying needs and concerns
- **Community Strengthening**: Leveraging conflict resolution to build more resilient community bonds
@@ -700,7 +700,7 @@ When emotions run high or productive communication becomes difficult:
**Recognition Signs:**
- Increasing emotional intensity or defensive responses
- Circular arguments without progress towards resolution
- Circular arguments without progress toward resolution
- Personal attacks or escalatory language
- Diminishing ability to listen or consider alternative perspectives
@@ -732,8 +732,8 @@ When direct communication fails to resolve conflicts, community-supported mediat
Community members serving as mediators should:
- **Maintain Neutrality**: Avoid taking sides or advocating for specific outcomes
- **Facilitate Communication**: Help parties express themselves clearly and listen effectively
- **Encourage Understanding**: Promote empathy and perspective-taking amongst parties
- **Focus on Solutions**: Guide discussions towards constructive problem-solving
- **Encourage Understanding**: Promote empathy and perspective-taking among parties
- **Focus on Solutions**: Guide discussions toward constructive problem-solving
- **Respect Confidentiality**: Maintain privacy about mediation discussions unless agreed otherwise
### 8.5. Staff Intervention and Escalation
@@ -926,7 +926,7 @@ When community enjoyment becomes consistently problematic:
**Issue Recognition:**
- Multiple members reporting similar negative experiences
- Consistent patterns of conflict or dissatisfaction
- Declining participation or enthusiasm amongst established members
- Declining participation or enthusiasm among established members
- Feedback indicating community culture issues
**Systemic Solutions:**
@@ -951,7 +951,7 @@ Our community adopts a permissive approach to mini-moderation, recognising its v
Appropriate mini-moderation includes:
**Welcoming and Integration Support:**
- Gently guiding new members towards understanding community norms and expectations
- Gently guiding new members toward understanding community norms and expectations
- Providing helpful information about community resources, channels, or practices
- Offering assistance with platform-specific features or navigation
- Sharing educational resources about community policies or inclusive practices
@@ -1043,7 +1043,7 @@ When mini-moderation becomes necessary:
**Indirect Redirection:**
- Model appropriate behaviour without explicitly correcting others
- Redirect conversations towards constructive directions through your own contributions
- Redirect conversations toward constructive directions through your own contributions
- Ask clarifying questions that encourage reflection rather than making direct accusations
- Provide positive alternatives that naturally guide discussions in better directions
src/content/docs/community/leadership.md
+4 -4
View File
@@ -12,7 +12,7 @@ This Community Leadership and Governance Policy (hereinafter referred to as "the
Our community leadership operates on the following foundational principles:
**(a)** **Servant Leadership**: Leaders serve the community rather than wielding authority for personal benefit. For a comprehensive explanation of servant leadership principles and how they apply to all staff roles, see [Staff Role Definition and Principles](/staff/handbook#22-staff-role-definition-and-principles) in the Staff Handbook;
**(a)** **Servant Leadership**: Leaders serve the community rather than wielding authority for personal benefit;
**(b)** **Transparency**: Decision-making processes and rationales are clearly communicated to the community;
@@ -60,7 +60,7 @@ Our community leadership operates through a structured hierarchy designed to ens
- **Moderators**: Front-line community moderation and member support
- **Mentors**: New member guidance and peer support programmes
- **Subject Matter Experts**: Specialised knowledge and educational support
- **Subject Matter Experts**: Specialized knowledge and educational support
- **Technical Contributors**: Development support and technical expertise for community platforms and tools
- **Quality Assurance Coordinator**: Testing and quality control for community platforms and resources
- **Data and Analytics Coordinator**: Community metrics analysis and reporting
@@ -271,7 +271,7 @@ Our community leadership operates through a structured hierarchy designed to ens
**Data and Analytics Coordinator:**
- Collect and analyse community engagement metrics and participation data
- Collect and analyze community engagement metrics and participation data
- Prepare regular reports on community health, growth trends, and member satisfaction
- Manage community surveys and feedback analysis for leadership decision-making
- Support leadership team with data insights and trend identification
@@ -319,7 +319,7 @@ Our community leadership operates through a structured hierarchy designed to ens
- Monitor member satisfaction and engagement levels across the community
- Mediate minor conflicts and facilitate communication between members
- Collect member feedback and suggestions for community improvements
- Maintain positive relationships and foster sense of belonging amongst community members
- Maintain positive relationships and foster sense of belonging among community members
**Documentation Support Technicians:**
src/content/docs/community/recognition.md
-12
View File
@@ -311,12 +311,6 @@ Nomination form can be found at https://forms.nhcarrigan.com/o/docs/forms/to2oFo
#### 6.2.2. Representative Recognition Outcomes
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
**Demographic Equity Monitoring:**
- Regular assessment of recognition distribution across different community demographic groups
- Proactive outreach to ensure recognition opportunities reach all community segments
@@ -395,12 +389,6 @@ We are working very hard to get them in place as soon as possible. If you would
#### 9.1.1. Continuous Improvement Process
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
**Monthly Program Assessment:**
- Recognition programme effectiveness evaluation and participant satisfaction assessment
- Recognition distribution analysis to ensure equity and inclusive representation
src/content/docs/dev/contributing.md
+2 -7
View File
@@ -153,11 +153,6 @@ You can also reach out to us in our Discord community: https://chat.nhcarrigan.c
### 4.1. Finding an Issue
**For Team Members:** All properly triaged tickets that are ready to be worked on are available on our **Staff Tickets** project board: https://git.nhcarrigan.com/nhcarrigan/-/projects/2
Team members should refer to this project board to find tickets that are ready for work.
**For All Contributors:**
1. Navigate to the project's issue tracker.
2. Browse open issues or use filters to find tasks that interest you.
3. Read the issue description thoroughly to understand the requirements and context.
@@ -545,7 +540,7 @@ Help improve the project's stability by:
Foster a welcoming and inclusive community by:
- Welcoming new contributors and helping them get started
- Organising or participating in community events or meetups
- Organizing or participating in community events or meetups
- Promoting the project on social media or relevant forums
- Helping to moderate community discussions
@@ -571,7 +566,7 @@ If you have connections or experience in this area:
- Help identify potential sponsors or grants
- Assist with writing grant applications
- Organise fundraising events or campaigns
- Organize fundraising events or campaigns
Or even make a donation yourself!
src/content/docs/dev/labels.md
+122 -312
View File
@@ -6,633 +6,443 @@ We use very specific labels to help categorise our issues. This page explains wh
## 1. Contribution Labels
These are the most important. These labels indicate who is encouraged to make a pull request to resolve the issue. All contributions are limited to our volunteer staff team members.
These are the most important. These labels indicate who is encouraged to make a pull request to resolve the issue.
### 1.1. `contribute: good first issue`
#### 1.1.1. Purpose
Identifies issues suitable for team members who are learning a new codebase.
Identifies issues suitable for contributors who are new to the project.
#### 1.1.2. Characteristics
Does not require prior knowledge of the codebase. Issues with this label should include a detailed description of the implementation process to help team members get familiar with the project structure.
Does not require prior knowledge of the codebase. Issues with this label should include a detailed description of the implementation process.
#### 1.1.3. Expectations
Team members are responsible for ensuring their work complies with the project's licensing terms and contribution guidelines.
Contributors are responsible for ensuring their work complies with the project's licensing terms and contribution guidelines.
### 1.2. `contribute: help wanted`
#### 1.2.1. Purpose
Indicates issues open for any team member to grab and work on.
Indicates issues open for contribution from any interested party.
#### 1.2.2. Characteristics
Open to all volunteer staff team members. May assume some familiarity with the codebase, and issues may not include a detailed implementation description.
Typically assumes prior experience with the codebase. As such, issues may not include a detailed implementation description.
#### 1.2.3. Expectations
Team members should review and adhere to the project's contribution guidelines and code of conduct before submitting work on these issues.
Contributors should review and adhere to the project's contribution guidelines and code of conduct before submitting work on these issues.
### 1.3. `contribute: staff only`
#### 1.3.1. Purpose
Designates issues restricted to executive leadership due to specific access requirements or strategic decisions.
Designates issues restricted to project maintainers or staff due to specific access requirements.
#### 1.3.2. Characteristics
Requires executive-level access, decision-making authority, or involves strategic project direction. Limited to authorised executive leadership team members.
Requires access to production infrastructure for proper testing and implementation. As such, limited to authorised project maintainers and staff.
#### 1.3.3. Expectations
Executive leadership members working on these issues must adhere to all relevant confidentiality agreements, data protection policies, and internal security protocols.
Staff members working on these issues must adhere to all relevant confidentiality agreements, data protection policies, and internal security protocols.
### 1.4. Disclaimer
Labels are assigned based on the project maintainers' best judgement but may not guarantee the exact level of difficulty or access requirements for every team member. Team members should use their discretion and communicate with project maintainers if they have any doubts about their ability to address an issue or comply with any associated legal requirements.
Labels are assigned based on the project maintainers' best judgement but may not guarantee the exact level of difficulty or access requirements for every contributor. Contributors should use their discretion and communicate with project maintainers if they have any doubts about their ability to address an issue or comply with any associated legal requirements.
## 2. Points Labels
Points labels indicate the complexity and effort required to resolve an issue. This helps with capacity planning and workload distribution across the team.
### 2.1. `points: 1`
#### 2.1.1. Purpose
Identifies very simple issues that require minimal effort and complexity.
#### 2.1.2. Characteristics
Straightforward tasks that can typically be completed quickly. Examples include minor text corrections, simple configuration changes, or very small bug fixes.
#### 2.1.3. Expectations
Team members should be able to complete these issues with minimal review time. These are ideal for quick wins and maintaining project momentum.
### 2.2. `points: 2`
#### 2.2.1. Purpose
Designates simple issues that require a bit more thought or investigation.
#### 2.2.2. Characteristics
Slightly more complex than 1-point issues but still relatively straightforward. May involve understanding a small portion of the codebase or making changes across a few files.
#### 2.2.3. Expectations
These issues should be approachable for most team members and can serve as good learning opportunities.
### 2.3. `points: 3`
#### 2.3.1. Purpose
Indicates moderate complexity issues that require more substantial work.
#### 2.3.2. Characteristics
Requires understanding multiple parts of the codebase or implementing features with several components. May involve testing, documentation, and coordination with other parts of the system.
#### 2.3.3. Expectations
Team members should have some familiarity with the codebase before tackling these issues. May require more thorough review and testing.
### 2.4. `points: 5`
#### 2.4.1. Purpose
Identifies complex issues that require significant effort and expertise.
#### 2.4.2. Characteristics
Involves substantial changes to the codebase, multiple components, or deep understanding of system architecture. May require refactoring, architectural decisions, or integration with external systems.
#### 2.4.3. Expectations
These issues typically require experienced team members and may involve multiple review cycles. Proper planning and discussion may be necessary before implementation.
### 2.5. `points: 8`
#### 2.5.1. Purpose
Designates very complex issues that require extensive work and deep expertise.
#### 2.5.2. Characteristics
Major features, significant refactoring, or complex architectural changes. Often involves multiple team members or requires breaking down into smaller sub-tasks.
#### 2.5.3. Expectations
These issues should be carefully planned and may need to be broken down into smaller, manageable pieces. Typically assigned to experienced team members with relevant expertise.
### 2.6. `points: 13`
#### 2.6.1. Purpose
Indicates extremely complex issues that represent major undertakings.
#### 2.6.2. Characteristics
Epic-level work that significantly impacts the project. Often requires breaking down into multiple smaller issues or involves substantial architectural changes.
#### 2.6.3. Expectations
These issues should always be broken down into smaller, trackable pieces. Requires careful planning, coordination, and likely involvement from multiple team members or executive leadership.
### 2.7. Disclaimer
Points are assigned based on the project maintainers' assessment of complexity and effort required. Actual time and effort may vary based on individual team member experience, unexpected complications, or changing requirements. Points should be used as a guide for planning and capacity management, not as strict time estimates.
## 3. Time Labels
Time labels indicate the expected number of days a developer should allocate for working on an issue. These help with sprint planning and workload management.
### 3.1. `time: <1 day`
#### 3.1.1. Purpose
Identifies issues that can be completed in less than one day of focused work.
#### 3.1.2. Characteristics
Quick fixes, minor updates, or simple tasks that don't require extensive development time. Typically aligns with 1-2 point issues.
#### 3.1.3. Expectations
These issues should be completable within a single work session. Ideal for maintaining project momentum and addressing quick wins.
### 3.2. `time: 1 day`
#### 3.2.1. Purpose
Designates issues that require approximately one full day of development work.
#### 3.2.2. Characteristics
Moderate tasks that can be completed in a focused day of work. May include some investigation, implementation, and basic testing.
#### 3.2.3. Expectations
Team members should be able to complete these issues within a single day, accounting for review time and potential minor revisions.
### 3.3. `time: 2-3 days`
#### 3.3.1. Purpose
Indicates issues requiring two to three days of development effort.
#### 3.3.2. Characteristics
More substantial work that involves multiple components, thorough testing, or deeper investigation. May require coordination with other team members.
#### 3.3.3. Expectations
These issues should be planned across multiple days, allowing time for implementation, testing, review cycles, and potential revisions.
### 3.4. `time: 4-5 days`
#### 3.4.1. Purpose
Identifies issues that require approximately one week of development work.
#### 3.4.2. Characteristics
Complex features or significant changes that require careful implementation, extensive testing, and multiple review cycles.
#### 3.4.3. Expectations
These issues should be allocated sufficient time for thorough development and review. May benefit from breaking down into smaller sub-tasks for better tracking.
### 3.5. `time: 1-2 weeks`
#### 3.5.1. Purpose
Designates issues requiring one to two weeks of focused development effort.
#### 3.5.2. Characteristics
Major features or substantial refactoring that requires careful planning, implementation across multiple areas, and comprehensive testing.
#### 3.5.3. Expectations
These issues should be carefully planned and may need to be broken down into smaller, trackable milestones. Requires coordination and regular check-ins with the team.
### 3.6. `time: >2 weeks`
#### 3.6.1. Purpose
Indicates issues that require more than two weeks of development work.
#### 3.6.2. Characteristics
Epic-level work or major architectural changes that significantly impact the project. Often involves multiple team members and extensive planning.
#### 3.6.3. Expectations
These issues must be broken down into smaller, manageable pieces. Require careful project management, regular milestones, and coordination across the team.
### 3.7. Disclaimer
Time estimates are based on typical development scenarios and may vary based on individual team member experience, unexpected complications, review cycles, or changing requirements. Time labels should be used as a guide for planning and should be adjusted based on actual progress and circumstances.
## 4. Aspect Labels
## 2. Aspect Labels
These labels indicate the scope of the work required to resolve the issue.
### 4.1. `aspect: code`
### 2.1. `aspect: code`
#### 4.1.1. Purpose
#### 2.1.1. Purpose
Identifies issues requiring changes to the project's codebase.
#### 4.1.2. Characteristics
#### 2.1.2. Characteristics
Involves direct modification to the project's source code. Familiarity with the languages and libraries used is expected.
#### 4.1.3. Expectations
#### 2.1.3. Expectations
Contributors must ensure their code changes comply with the project's coding standards, license terms, and any applicable software patents or copyrights.
### 4.2. `aspect: dx`
### 2.2. `aspect: dx`
#### 4.2.1. Purpose
#### 2.2.1. Purpose
Indicates issues related to improving the project's tooling and development workflow.
#### 4.2.2. Characteristics
#### 2.2.2. Characteristics
May include changes to automated tests, development dependencies, build processes, etc. Understanding of the development workflows is expected.
#### 4.2.3. Expectations
#### 2.2.3. Expectations
Changes to tooling or dependencies must be compatible with the project's overall licensing strategy and not introduce conflicts with existing terms.
### 4.3. `aspect: interface`
### 2.3. `aspect: interface`
#### 4.3.1. Purpose
#### 2.3.1. Purpose
Designates issues that affect the end-user's experience with the project.
#### 4.3.2. Characteristics
#### 2.3.2. Characteristics
May require changes in the code, particularly in front-end components. Can include visual modifications like CSS changes or image updates. Understanding of the end-user experience expected.
#### 4.3.3. Expectations
#### 2.3.3. Expectations
Contributors must ensure they have the necessary rights to any visual assets introduced or modified. Changes should comply with accessibility standards and regulations where applicable.
### 4.4. `aspect: text`
### 2.4. `aspect: text`
#### 4.4.1. Purpose
#### 2.4.1. Purpose
Identifies issues related to the project's documentation.
#### 4.4.2. Characteristics
#### 2.4.2. Characteristics
Typically does not require code changes. Proficiency in technical writing is a must.
#### 4.4.3. Expectations
#### 2.4.3. Expectations
Contributors must ensure the accuracy of the information provided in documentation updates. Documentation changes should adhere to any applicable style guides and licensing terms.
### 4.5. Disclaimer
### 2.5. Disclaimer
Aspect labels are assigned based on the primary focus of the issue but may not encompass all potential areas of impact. Contributors are encouraged to consider potential cross-aspect effects of their work and discuss these with project maintainers when in doubt. The project maintainers reserve the right to reassign aspect labels or request additional changes if the submitted work does not align with the intended scope of the issue.
## 5. Goal Labels
## 3. Goal Labels
These labels indicate the primary objective of the issue, reflecting our project's modular approach. They help contributors understand the nature and scope of the changes they'll be making.
### 5.1. `goal: addition`
### 3.1. `goal: addition`
#### 5.1.1. Purpose
#### 3.1.1. Purpose
Identifies issues that involve adding a new feature to the project.
#### 5.1.2. Characteristics
#### 3.1.2. Characteristics
Typically involves creating new code files. Understanding of how different modules in the project integrate with each other is expected.
#### 5.1.3. Expectations
#### 3.1.3. Expectations
Contributors must ensure that new features do not infringe on existing patents or copyrights. New code should be compatible with the project's existing license. If introducing third-party libraries or dependencies, their licenses must be compatible with the project's license.
### 5.2. `goal: fix`
### 3.2. `goal: fix`
#### 5.2.1. Purpose
#### 3.2.1. Purpose
Designates issues aimed at fixing bugs in the project.
#### 5.2.2. Characteristics
#### 3.2.2. Characteristics
Typically involves editing code within existing files. Scope should be kept to the specific bug - separate contributions should be made for unrelated bugs.
#### 5.2.3. Expectations
#### 3.2.3. Expectations
Bug fixes should not introduce new legal issues or licensing conflicts. Contributors should document the nature of the bug and the fix for future reference and potential legal compliance (e.g., security vulnerabilities).
### 5.3. `goal: improvement`
### 3.3. `goal: improvement`
#### 5.3.1. Purpose
#### 3.3.1. Purpose
Indicates issues that expand upon or enhance existing features.
#### 5.3.2. Characteristics
#### 3.3.2. Characteristics
Usually involves adding code to existing files. Scope should be kept to the existing feature.
#### 5.3.3. Expectations
#### 3.3.3. Expectations
Improvements should maintain compatibility with existing licenses and legal obligations. If the improvement significantly changes the functionality, consider if additional legal reviews or updates to user agreements are necessary.
### 5.4. Disclaimer
### 3.4. Disclaimer
While goal labels provide guidance on the nature of the task, the actual work required may vary or expand beyond the initial scope. Contributors are encouraged to communicate with project maintainers if they believe a different approach or additional changes are necessary to achieve the goal. The project maintainers reserve the right to request modifications or additional work to ensure that contributions align with the project's goals, standards, and legal requirements.
## 6. Priority Labels
## 4. Priority Labels
Priority labels indicate the importance assigned to specific issues by the project maintainers. These labels help guide resource allocation and set expectations for resolution timeframes.
### 6.1. `priority: critical`
### 4.1. `priority: critical`
#### 6.1.1. Purpose
#### 4.1.1. Purpose
Identifies issues requiring immediate attention due to their severe impact on project usability.
#### 6.1.2. Characteristics
#### 4.1.2. Characteristics
Require urgent resolution to restore project functionality. Experience with the project is a must, to avoid delays from long review processes.
#### 6.1.3. Expectations
#### 4.1.3. Expectations
May involve security vulnerabilities or critical bugs that could lead to legal liabilities if not addressed promptly. Resolution of these issues may need to be reported to relevant stakeholders or authorities in certain cases (e.g., data protection regulators for security breaches).
### 6.2. `priority: high`
### 4.2. `priority: high`
#### 6.2.1. Purpose
#### 4.2.1. Purpose
Designates important issues that, while not preventing basic functionality, are impeding further development.
#### 6.2.2. Characteristics
#### 4.2.2. Characteristics
Not critical for current project operation but blocking future progress. Require prompt attention to unblock development efforts.
#### 6.2.3. Expectations
#### 4.2.3. Expectations
May involve compliance deadlines or contractual obligations that need to be met. Could impact project timelines, potentially affecting agreements with stakeholders or clients.
### 6.3. `priority: medium`
### 4.3. `priority: medium`
#### 6.3.1. Purpose
#### 4.3.1. Purpose
Indicates issues that need resolution as soon as possible but are not blocking other development.
#### 6.3.2. Characteristics
#### 4.3.2. Characteristics
Important for project improvement but not critical for current functionality. Should be addressed in a timely manner but with less urgency than high-priority issues.
#### 6.3.3. Expectations
#### 4.3.3. Expectations
May involve improvements to user experience or accessibility, which could have legal implications if neglected long-term. Could relate to optimisations that affect performance guarantees or service level agreements.
### 6.4. `priority: low`
### 4.4. `priority: low`
#### 6.4.1. Purpose
#### 4.4.1. Purpose
Represents issues that should be resolved but are not considered urgent.
#### 6.4.2. Characteristics
#### 4.4.2. Characteristics
Desirable improvements or minor issues that don't significantly impact project functionality.
#### 6.4.3. Expectations
#### 4.4.3. Expectations
While not urgent, neglecting these issues over time could lead to technical debt or gradual degradation of project quality, potentially affecting long-term compliance or user satisfaction.
### 6.5. `priority: none`
### 4.5. `priority: none`
#### 6.5.1. Purpose
#### 4.5.1. Purpose
Identifies "nice-to-have" issues that are not essential for project functionality or immediate development goals.
#### 6.5.2. Characteristics
#### 4.5.2. Characteristics
Not critical enough to dedicate maintainer time for resolution. Often left for future consideration or when team capacity allows.
Not critical enough to dedicate maintainer time for resolution. Often left for community contributors or future consideration.
#### 6.5.3. Expectations
#### 4.5.3. Expectations
While not prioritised, maintainers should periodically review these issues to ensure they haven't become more significant over time, potentially accruing legal or compliance risks.
### 6.6. Disclaimer
### 4.6. Disclaimer
Priority labels reflect the project maintainers' current assessment and may be subject to change. The presence of a lower-priority label does not diminish the importance of the issue or the value of contributions addressing it. Contributors should communicate with maintainers if they believe an issue's priority should be reassessed due to new information or changing circumstances.
## 7. Status Labels
## 5. Status Labels
Status labels indicate the current stage of an issue in the project lifecycle. These labels help manage workflow and set expectations for contributors and users.
### 7.1. `status: awaiting triage`
### 5.1. `status: awaiting triage`
#### 7.1.1. Purpose
#### 5.1.1. Purpose
Identifies newly created issues that have not yet been reviewed by the maintainer team.
#### 7.1.2. Characteristics
#### 5.1.2. Characteristics
Should be applied to issues when they are opened.
#### 7.1.3. Expectations
#### 5.1.3. Expectations
Contributors should be aware that engaging with these issues is at their own discretion, as the project team has not yet evaluated them. Maintainers should establish a reasonable timeframe for initial triage to manage expectations and potential liability.
### 7.2. `status: blocked`
### 5.2. `status: blocked`
#### 7.2.1. Purpose
#### 5.2.1. Purpose
Indicates issues with a planned resolution that depend on the completion of another issue.
#### 7.2.2. Characteristics
#### 5.2.2. Characteristics
Not yet ready for work but expected to be addressed in the future.
#### 7.2.3. Expectations
#### 5.2.3. Expectations
Maintainers should clearly document dependencies to avoid potential conflicts or misunderstandings. Regular review of blocked issues is advisable to prevent indefinite delays that could impact project timelines or contractual obligations.
### 7.3. `status: discarded`
### 5.3. `status: discarded`
#### 7.3.1. Purpose
#### 5.3.1. Purpose
Designates issues that the project team does not intend to resolve.
#### 7.3.2. Characteristics
#### 5.3.2. Characteristics
Typically applied to feature requests that don't align with project goals.
#### 7.3.3. Expectations
#### 5.3.3. Expectations
Clearly communicate the rationale for discarding issues to manage user expectations and maintain transparency. Ensure that discarded issues don't conflict with any promised features or contractual obligations.
### 7.4. `status: discontinued`
### 5.4. `status: discontinued`
#### 7.4.1. Purpose
#### 5.4.1. Purpose
Applies to feature requests for projects in maintenance mode.
#### 7.4.2. Characteristics
#### 5.4.2. Characteristics
Indicates no new features will be added, but bug fixes and support continue.
#### 7.4.3. Expectations
#### 5.4.3. Expectations
Clearly communicate the project's maintenance status to manage user expectations and potential liability. Ensure that discontinuation doesn't breach any ongoing support agreements or licenses.
### 7.5. `status: label work required`
### 5.5. `status: label work required`
#### 7.5.1. Purpose
#### 5.5.1. Purpose
Indicates issues that need proper labelling and categorisation.
#### 7.5.2. Characteristics
#### 5.5.2. Characteristics
May have ongoing discussions but lack appropriate classification.
#### 7.5.3. Expectations
#### 5.5.3. Expectations
Proper labelling is crucial for efficient project management and may have implications for compliance tracking and reporting. Establish clear guidelines for labelling to ensure consistency and avoid potential misunderstandings.
### 7.6. `status: ready for dev`
### 5.6. `status: ready for dev`
#### 7.6.1. Purpose
#### 5.6.1. Purpose
Signifies issues that are ready for contribution.
#### 7.6.2. Characteristics
#### 5.6.2. Characteristics
May have an assigned contributor who has expressed interest.
#### 7.6.3. Finding Ready-to-Work Tickets
All properly triaged tickets with the `status: ready for dev` label are available on our **Staff Tickets** project board: https://git.nhcarrigan.com/nhcarrigan/-/projects/2
Team members should refer to this project board to find tickets that are ready to be worked on.
#### 7.6.4. Expectations
#### 5.6.3. Expectations
Clearly communicate contribution guidelines and any legal requirements (e.g., Contributor Covenant) to potential contributors. Ensure that collaborative efforts are managed in compliance with project licenses and contributor agreements.
### 7.7. `status: ticket work required`
### 5.7. `status: ticket work required`
#### 7.7.1. Purpose
#### 5.7.1. Purpose
Indicates issues lacking sufficient information for proper triage.
#### 7.7.2. Characteristics
#### 5.7.2. Characteristics
Often paired with Conversation Labels for further clarification.
#### 7.7.3. Expectations
#### 5.7.3. Expectations
Establish clear guidelines for required information to avoid potential misunderstandings or misdirected efforts. Be mindful of data privacy when requesting additional information from issue reporters.
### 7.8. Disclaimer
### 5.8. Disclaimer
Status labels reflect the current assessment of the project team and may change as circumstances evolve. While the project team strives to maintain accurate status labels, contributors and users should communicate with maintainers if they notice any discrepancies or have questions about an issue's status.
## 8. Conversation Labels
## 6. Conversation Labels
Conversation labels indicate that an issue has received initial maintainer attention but requires further discussion or information before proceeding. These labels help manage communication and ensure all necessary information is gathered before taking action.
### 8.1. `talk: discussion`
### 6.1. `talk: discussion`
#### 8.1.1. Purpose
#### 6.1.1. Purpose
Identifies issues that are under active discussion but have not yet been accepted for resolution.
#### 8.1.2. Characteristics
#### 6.1.2. Characteristics
Ongoing dialogue between maintainers, contributors, and/or users. May involve debates about feature requests, implementation strategies, or project direction.
#### 8.1.3. Expectations
#### 6.1.3. Expectations
Ensure discussions remain constructive and adhere to the project's code of conduct. Be cautious about making commitments or promises during discussions that could create legal obligations. Document key decisions and rationales to maintain transparency and provide a record for future reference.
### 8.2. `talk: question`
### 6.2. `talk: question`
#### 8.2.1. Purpose
#### 6.2.1. Purpose
Indicates issues waiting on additional information from the author for proper triage.
#### 8.2.2. Characteristics
#### 6.2.2. Characteristics
Requires clarification or more details from the issue creator. Cannot proceed with triage or resolution until the requested information is provided.
#### 8.2.3. Expectations
#### 6.2.3. Expectations
Clearly communicate what information is needed and why it's necessary. Be mindful of data privacy when requesting additional information. Establish and communicate timeframes for expected responses to manage the issue lifecycle efficiently.
### 8.3. Disclaimer
### 6.3. Disclaimer
Conversation labels indicate ongoing dialogue and do not guarantee that an issue will be implemented or resolved in a specific manner. Participants should understand that project priorities and decisions may change based on new information or project direction.
## 9. Pull Request Labels
## 7. Pull Request Labels
Pull Request (PR) labels are used to indicate the current status of pull requests and guide contributors through the review and merge process.
### 9.1. `pull: merge conflict`
### 7.1. `pull: merge conflict`
#### 9.1.1. Purpose
#### 7.1.1. Purpose
Indicates that the pull request has conflicts with the target branch.
#### 9.1.2. Characteristics
#### 7.1.2. Characteristics
Conflicts need to be resolved before the PR can be reviewed or merged. May require action from the original contributor or project maintainers.
#### 9.1.3. Expectations
#### 7.1.3. Expectations
Clearly communicate the responsibility for resolving conflicts (e.g., whether it's the contributor's or maintainer's role). Ensure that conflict resolution doesn't introduce unintended changes or legal issues (e.g., license conflicts).
### 9.2. `pull: ready for review`
### 7.2. `pull: ready for review`
#### 9.2.1. Purpose
#### 7.2.1. Purpose
Signifies that the pull request is not in draft mode and is awaiting maintainer review.
#### 9.2.2. Characteristics
#### 7.2.2. Characteristics
PR has been submitted as complete and ready for evaluation. Maintainers should prioritise reviewing these PRs.
#### 9.2.3. Expectations
#### 7.2.3. Expectations
Ensure contributors understand that "ready for review" doesn't guarantee acceptance or merging. Maintain clear review criteria and communicate them to contributors.
### 9.3. `pull: requires update`
### 7.3. `pull: requires update`
#### 9.3.1. Purpose
#### 7.3.1. Purpose
Indicates that the maintainer team has requested changes to the pull request.
#### 9.3.2. Characteristics
#### 7.3.2. Characteristics
Feedback has been provided, and updates are needed before further review or merging. Requires action from the contributor to address the requested changes.
#### 9.3.3. Expectations
#### 7.3.3. Expectations
Clearly document requested changes to maintain transparency and avoid misunderstandings. Consider setting timeframes for updates to manage the PR lifecycle effectively.
### 9.4. Disclaimer
### 7.4. Disclaimer
The presence of these labels does not guarantee that a pull request will be merged. All contributions must still meet the project's quality standards, guidelines, and legal requirements.
## 10. Continuous Improvement
## 8. Continuous Improvement
We encourage all project participants to provide feedback on our labelling system. If you have suggestions for improvements or notice any inconsistencies, please reach out to us in our [Discord community](https://chat.nhcarrigan.com).
## 11. Legal Notice
## 9. Legal Notice
This labels documentation is provided for informational purposes and to facilitate project management. It does not constitute a legal agreement. All contributions to the project must comply with the project's license, contributor agreement (if applicable), and relevant laws and regulations.
src/content/docs/dev/servers.md
+428
View File
@@ -0,0 +1,428 @@
---
title: Server Setup
---
**ESTABLISHING SERVER CONFIGURATION STANDARDS AND SECURITY REQUIREMENTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Server Setup Documentation (hereinafter referred to as "the Documentation") establishes mandatory standards, procedures, and security requirements for configuring remote servers used to host projects maintained by our organisation. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Security Policy, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all remote servers used to host projects, services, or infrastructure maintained by our organisation. All personnel responsible for server configuration, deployment, or maintenance must comply with the standards set forth in this Documentation.
**IMPORTANT: Non-compliance with server security and configuration standards set forth in this Documentation may result in security vulnerabilities, service disruptions, or other serious consequences. All server administrators must strictly adhere to these requirements.**
### 1.3. Security and Compliance Requirements
Server configuration must comply with:
- Our Security Policy and security standards
- Applicable data protection and privacy regulations
- Industry best practices for server security
- All relevant legal and regulatory requirements
## 2. PROVISIONING A SERVER
We use DigitalOcean as our provider. Regardless of your choice, provision a new VPS using the **latest Ubuntu LTS version**. Add your `ssh` key AND Naomi's `ssh` key in the setup process.
## 3. SETTING UP USER ACCOUNTS
You should never run applications on root. SSH into the new VPS to prepare your user.
### 3.1. Creating the User Account
You'll need to set a password for the `root` account first.
```bash
passwd
```
Once you have set a password, ensure that you have provided it to Naomi to store in the vault.
Create an `NHCarrigan` user for our organisation.
```bash
adduser NHCarrigan
```
Set a **different** password, and provide that to Naomi as well. For all of the user information, use the default blank values.
Add the new user to the sudoers file.
```bash
usermod -aG sudo NHCarrigan
```
Then sync the SSH keys so we can authenticate as that user.
```bash
rsync --archive --chown=NHCarrigan:NHCarrigan ~/.ssh /home/NHCarrigan
```
While you are there, set the timezone for the server to our business' local timezone.
```bash
sudo timedatectl set-timezone America/Los_Angeles
```
## 4. PREPARING FOR WEB REQUESTS
To prepare the server to receive web requests, you'll need to follow a few steps.
### 4.1. SSL Certificate Configuration
:::note
If the Firewall has been set up, you'll need to temporarily allow port 80 for the certificate to generate.
:::
We use LetsEncrypt to provision our SSL certificates. If it is not installed, install it with:
```bash
sudo snap install --classic certbot
```
Then link the snap to our `usr` directory.
```bash
sudo ln -s /snap/bin/certbot /usr/bin/certbot
```
Generate a certificate with:
```bash
sudo certbot certonly --standalone
```
And allow applications to read it:
```bash
sudo chmod -R a+rwx /etc/letsencrypt
```
When you need to renew the certificate:
```bash
sudo certbot renew
```
### 4.2. NGINX Configuration
All requests should be routed through NGINX. At no point should an application run directly on ports 80 or 443.
Install NGINX:
```bash
sudo apt-get install nginx
```
Edit the configuration file:
```bash
sudo emacs /etc/nginx/conf.d/server.conf
```
Use this template to set up a reverse proxy on the standard HTTPS port 443:
```nginx
server {
listen 443 ssl;
server_name subdomain.domain.tld;
ssl_certificate /etc/letsencrypt/live/subdomain.domain.tld/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/subdomain.domain.tld/privkey.pem;
location / {
proxy_set_header Host $host;
proxy_pass https://127.0.0.1:port;
proxy_redirect off;
}
}
```
Validate that the config is correct with:
```bash
sudo nginx -t
```
If so, restart NGINX to apply the changes:
```bash
sudo systemctl restart nginx
```
## 5. SECURING THE SERVER
We have a minimum level of security that is required on ALL of our servers. This section should not be treated as the best effort, but as the minimal requirements to comply with our policies.
### 5.1. Firewall Configuration
We use `ufw` as our firewall. First, enable the SSH port.
```bash
sudo ufw allow "OpenSSH"
```
Then, allow the standard HTTPS port and **deny** the standard HTTP port.
```bash
sudo ufw deny http
sudo ufw allow https
```
Enable the firewall. You may get dropped from the SSH connection.
```bash
sudo ufw enable
```
### 5.2. Fail2Ban Configuration
We also use Fail2Ban to block IP addresses which fail to make requests too often.
Install the tool:
```bash
sudo apt-get install fail2ban
```
Configure the NGINX jail in `/etc/fail2ban/jail.d/nginx-auth.conf`:
```ini
[nginx-auth]
enabled = true
filter = nginx-auth
logpath = /var/log/nginx/access.log
maxretry = 3
findtime = 86400
bantime = 86400
```
Configure the NGINX filter in `/etc/fail2ban/filter.d/nginx-auth.conf`:
```ini
[Definition]
failregex = ^<HOST> - .* \[.*\] ".*" (4\d{2}) .*$
```
Because we use Cloudflare, you'll need to grab the original IP for all requests. Start by creating a file to store Cloudflare's IPs.
```bash
sudo touch /etc/nginx/cloudflare_ips.conf
```
Then create your script:
```bash
nano ~/update_cf_ips.sh
```
```bash
#!/bin/bash
# Create a temporary file
temp_file=$(mktemp)
# Download IPv4 ranges and format each line
curl -s https://www.cloudflare.com/ips-v4 | while read ip; do
echo "set_real_ip_from $ip;" >> "$temp_file"
done
# Download IPv6 ranges and format each line
curl -s https://www.cloudflare.com/ips-v6 | while read ip; do
echo "set_real_ip_from $ip;" >> "$temp_file"
done
# Add the real_ip_header directive
echo "real_ip_header CF-Connecting-IP;" >> "$temp_file"
# Replace the old file with the new one
sudo mv "$temp_file" /etc/nginx/cloudflare_ips.conf
# Test Nginx configuration
sudo nginx -t
# If the test is successful, reload Nginx
if [ $? -eq 0 ]; then
sudo systemctl reload nginx
echo "Nginx configuration updated and reloaded successfully."
else
echo "Nginx configuration test failed. Please check your configuration."
fi
```
Make it executable and run it:
```bash
sudo chmod +x update_cf_ips.sh
sudo ./update_cf_ips.sh
```
If it runs as expected, set it up to run on a CRON.
```bash
sudo crontab -e
```
```bash
0 3 * * 1 ~/update_cf_ips.sh
```
Then, update the `/etc/nginx/nginx.conf` to use all of this new logic. This goes at the end of your `http` directive block.
```nginx
# Look at the real IP, not the cloudflare IP.
include /etc/nginx/cloudflare_ips.conf;
log_format custom_format '$remote_addr - $remote_user [$time_local] '
'"$request" $status $body_bytes_sent '
'"$http_referer" "$http_user_agent" '
'"$http_x_forwarded_for"';
access_log /var/log/nginx/access.log custom_format;
```
Confirm the NGINX configuration is correct:
```bash
sudo nginx -t
```
Then restart everything.
```bash
sudo systemctl restart nginx
sudo systemctl restart fail2ban
```
To view banned IPs:
```bash
sudo fail2ban-client status nginx-auth
```
And to unban them:
```bash
sudo fail2ban-client set nginx-auth unbanip <ip>
```
## 6. UPLOADING PROJECTS
To upload a project, you should **not** use `git` to clone the project to the machine. Instead, start by cloning the project to your local environment and navigating to the directory:
```bash
git clone <url>
cd /path/to/project
```
Then sync the project up to the machine, ignoring any installed packages.
```bash
rsync -av --exclude='node_modules' ./ <server name>:/home/NHCarrigan/<project directory>
```
## 7. RUNNING PROJECTS
Now you are ready to start running the project.
### 7.1. Node.js Setup
Most of our projects will run on Node. For a new machine, you'll need to set that up.
We use `nvm` to manage Node versions. Fetch and run the install script:
```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
```
The script will automatically update the `.bashrc` file to load `nvm` into the PATH. Reload that:
```bash
source ~/.bashrc
```
Install the long-term support Node version.
```bash
nvm install --lts
```
This should automatically set it as the default. When updating, be sure to remove any older versions!
Finally, install `pnpm` as the package manager.
```bash
npm i -g pnpm
```
### 7.2. PM2 Process Management
All of our processes run with PM2 to allow for monitoring and auto-restarts. You'll need to install it.
```bash
pnpm i -g pm2
```
To start a project, use this template:
```bash
pm2 start '<script>' --name '<name>'
```
Then run `pm2 save` to save the application list.
## 8. LIMITATION OF LIABILITY AND DISCLAIMERS
### 8.1. Reference to Comprehensive Liability Framework
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
### 8.2. Server Configuration Disclaimer
This Documentation establishes mandatory security and configuration standards. However, compliance with these standards does not guarantee:
- Complete protection against all security threats or vulnerabilities
- Uninterrupted service availability or performance
- Compatibility with all applications or use cases
- Protection against all forms of attack or compromise
### 8.3. Security Disclaimer
While this Documentation establishes security requirements, server administrators are responsible for:
- Implementing additional security measures appropriate to their specific threat environment
- Regularly updating and patching all software and dependencies
- Monitoring server logs and security alerts
- Responding promptly to security incidents
- Maintaining compliance with all applicable security regulations and standards
### 8.4. Third-Party Services and Tools
This Documentation references various third-party services, tools, and software packages. Our organisation:
- Does not guarantee the security, availability, or functionality of third-party services
- Is not responsible for issues arising from the use of third-party tools or services
- Recommends that administrators review third-party licenses, terms of service, and security practices
- Does not provide support for third-party tools beyond what is necessary for project functionality
### 8.5. Technical Accuracy Disclaimer
While we strive to maintain accurate and current information in this Documentation, technical standards, software versions, and security best practices evolve continuously. Server administrators are responsible for:
- Verifying current software versions and compatibility
- Adapting configurations to their specific system requirements
- Ensuring compliance with current security standards and regulations
- Consulting additional resources for the most current security recommendations
## 9. CONCLUSION
This Server Setup Documentation establishes mandatory standards and procedures for configuring remote servers used to host projects maintained by our organisation. Strict adherence to these requirements is essential for maintaining security, reliability, and compliance with our organisational policies and legal obligations.
All personnel responsible for server configuration, deployment, or maintenance must familiarise themselves with and comply with the requirements set forth in this Documentation. Questions about server configuration requirements or security standards should be directed to appropriate technical leadership through designated communication channels.
---
*For questions about server configuration requirements or to suggest improvements, please contact technical leadership through the designated channels outlined in our Security Policy.*
src/content/docs/dev/style.md
+1 -3
View File
@@ -12,12 +12,10 @@ This Style Guide (hereinafter referred to as "the Guide") establishes mandatory
### 1.2. Scope and Applicability
This Guide applies to all code contributions to NHCarrigan-maintained repositories, regardless of contributor status. All contributors to our projects are required to comply with the standards set forth in this Guide.
This Guide applies to all code contributions, regardless of contributor status, project type, or development context. All contributors are required to comply with the standards set forth in this Guide.
**IMPORTANT: Non-compliance with this Guide may result in rejection of contributions, requests for modification, or other appropriate actions as determined by project maintainers.**
**Note for Mentorship Programme Participants:** This Guide governs contributions to NHCarrigan-maintained repositories only. It does not apply to your flagship project. Your flagship project is your own intellectual property, and you are entirely free to set your own style standards, choose your own licence, and use your own copyright attribution.
### 1.3. Legal Compliance and Intellectual Property
All code contributions must comply with:
src/content/docs/dev/vtubing.md
+54
View File
@@ -0,0 +1,54 @@
---
title: Naomi's VTubing Setup
---
Naomi uses her VTuber model for all of her client meetings, as well as streaming. Getting the software to work on Linux is a bit of a nightmare, so this page documents how she does so.
## 1. OpenSeeFace
In order to track her webcamera, OpenSeeFace needs to be run independently as a native script.
### 1.1. Installation
This should all be done in your home `~` directory.
- Begin by cloning the repository:
- `git clone https://github.com/emilianavt/OpenSeeFace`
- `cd OpenSeeFace`
- You will need to prepare Python
- Install the packages: `yay -Sy python python-virtualenv`
- Prepare the environment: `virtualenv -p python3 env`
- Source the environment: `source env/bin/activate`
- Install the dependencies: `pip3 install onnxruntime opencv-python pillow numpy`
### 1.2. Running
```
cd OpenSeeFace
source env/bin/activate
python facetracker.py -c 0 -W 1280 -H 720 --discard-after 0 --scan-every 0 --no-3d-adapt 1 --max-feature-updates 900
```
## 2. VSeeFace
VSeeFace does not run natively, and will need to run with Wine.
### 2.1. Installation
[Download and run the installer](https://www.vseeface.icu/#download). When selecting a directory, put it in `~/VSeeFace`.
### 2.2. Running
```bash
wine ~/VSeeFace/VSeeFace.exe --background-color "#00FF00"
```
The `--background-color` flag creates a green screen background to be chroma-keyed out by OBS.
## 3. OBS
OBS allows for virtual camera, as well as for streaming.
### 3.1. Installation
The `obs-studio-git` AUR package is Naomi's current installation.
src/content/docs/legal/aup.md
+18 -14
View File
@@ -8,7 +8,7 @@ title: Acceptable Use Policy
### 1.1. Policy Purpose
This Acceptable Use Policy ("AUP") establishes comprehensive guidelines for the appropriate use of all services, applications, and platforms provided by NHCarrigan ("we," "us," "our," or "the Company"). This AUP operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, and all applicable legal protections by reference, and supplements these policies to provide detailed guidance on acceptable and prohibited usage patterns.
This Acceptable Use Policy ("AUP") establishes comprehensive guidelines for the appropriate use of all services, applications, and platforms provided by NHCarrigan ("we," "us," "our," or "the Company"). This AUP supplements our Terms of Service and other applicable policies to provide detailed guidance on acceptable and prohibited usage patterns.
### 1.2. Scope of Application
@@ -28,7 +28,19 @@ This AUP applies to all users of our Services, including:
### 1.3. Integration with Other Policies
This AUP operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Service Level Agreement, Content and Moderation Policy, Limitation of Liability and Indemnification Policy, and all applicable legal protections by reference.
This AUP operates in conjunction with our comprehensive policy framework:
**(a)** Our Terms of Service, which establish the fundamental legal relationship;
**(b)** Our Community Code of Conduct, which governs community interactions;
**(c)** Our Privacy Policy, which governs data collection and processing;
**(d)** Our Service Level Agreement and Warranty Disclaimer, which define service expectations and warranties;
**(e)** Our Content and Moderation Policy, which establishes detailed content standards and moderation procedures;
**(f)** Our Limitation of Liability and Indemnification Policy, which governs all liability and risk allocation matters;
**(g)** Our Export Control and Sanctions Compliance Policy, which governs international trade compliance;
@@ -446,12 +458,6 @@ When handling data through our services:
### 8.1. Monitoring and Detection
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
We employ various methods to monitor compliance with this AUP:
**(a)** **Automated Monitoring**: Automated systems to detect prohibited activities;
@@ -518,7 +524,7 @@ Users may appeal enforcement actions through:
**(b)** **Evidence Submission**: Opportunity to provide evidence and explanations;
**(c)** **Independent Review**: Review by Team members not involved in the original decision;
**(c)** **Independent Review**: Review by staff members not involved in the original decision;
**(d)** **Corrective Actions**: Opportunity to take corrective actions to address violations;
@@ -664,19 +670,17 @@ For questions about this AUP:
**Subject Line:** AUP Inquiry - [Brief Description]
**Response Time:** Within 7-10 business days for policy clarification requests
**Response Time:** Within 3 business days for policy clarification requests
### 11.2. Violation Reporting
To report policy violations:
**Incident Report Form** (Preferred): Submit reports through our official Incident Report Form: https://forms.nhcarrigan.com/o/docs/forms/t7CYeYS4uyUuLiKFatoEvs/4
**Email:** abuse@nhcarrigan.com
**Subject Line:** Policy Violation Report - [Service/Platform]
**Response Time:** Within 7-10 business days for all reports
**Response Time:** Within 24 hours for urgent safety issues, 48 hours for standard reports
### 11.3. Appeals and Disputes
@@ -696,7 +700,7 @@ For technical issues related to policy compliance:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for technical support requests
**Response Time:** Within 48 hours for technical support requests
---
src/content/docs/legal/community-growth-policy.md
+13 -13
View File
@@ -30,7 +30,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
**Social Justice Alignment:**
- **Anti-Oppression Focus**: Growth efforts that actively support marginalised communities
- **Accessibility Prioritisation**: Ensuring growth includes people with diverse abilities and needs
- **Accessibility Prioritization**: Ensuring growth includes people with diverse abilities and needs
- **Economic Justice**: Growth that doesn't exclude people based on economic circumstances
- **Environmental Responsibility**: Sustainable growth practices that minimise environmental impact
- **Democratic Participation**: Growth that strengthens rather than dilutes community democracy
@@ -84,7 +84,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
**Platform-Specific Approaches:**
- **Discord**: Share invites thoughtfully with context about what people can expect
- **Reddit**: Participate authentically in relevant subreddits whilst mentioning community when appropriate
- **Reddit**: Participate authentically in relevant subreddits while mentioning community when appropriate
- **Bluesky/Twitter**: Share community content and values-aligned information with appropriate hashtags
- **LinkedIn**: Professional content that demonstrates community values in professional contexts
- **GitHub**: Technical contributions and documentation that showcase community technical work
@@ -117,7 +117,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Accessibility Support**: Help ensure events are accessible to diverse participants
- **Follow-Up Engagement**: Connect with new participants after events to support integration
**Event Hosting and Organisation:**
**Event Hosting and Organization:**
- **Values Integration**: Ensure all events reflect and support community values
- **Accessibility Planning**: Plan events that are accessible to people with diverse needs
- **Inclusive Environment**: Create environments where diverse participants feel welcome
@@ -130,7 +130,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Conference Participation**: Represent the community at relevant conferences and gatherings
- **Workshop Facilitation**: Offer workshops that showcase community values and approach
- **Panel Participation**: Participate in panels that advance community values and visibility
- **Networking Events**: Network authentically whilst representing community values
- **Networking Events**: Network authentically while representing community values
- **Educational Presentations**: Present about community work and impact
**Best Practices for External Representation:**
@@ -140,7 +140,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Follow-Up Systems**: Have systems in place to follow up with interested individuals
- **Community Coordination**: Coordinate with community leadership about external representation
## 3. ORGANISATIONAL GROWTH STRATEGIES
## 3. ORGANIZATIONAL GROWTH STRATEGIES
### 3.1. Partnership Development
@@ -182,7 +182,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
**Priority Communities:**
- **Marginalised Identities**: Prioritise outreach to communities that are underrepresented in tech and social justice spaces
- **Geographic Diversity**: Seek geographic diversity whilst respecting cultural differences
- **Geographic Diversity**: Seek geographic diversity while respecting cultural differences
- **Economic Accessibility**: Ensure growth includes people from diverse economic backgrounds
- **Accessibility Needs**: Actively recruit people with disabilities and diverse accessibility needs
- **Age Diversity**: Welcome participation across age groups and generational perspectives
@@ -198,7 +198,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
**Skill and Interest Alignment:**
- **Technical Communities**: Outreach to technical communities interested in ethical technology
- **Social Justice Organisations**: Connection with organisations working on related social justice issues
- **Social Justice Organizations**: Connection with organisations working on related social justice issues
- **Gaming Communities**: Authentic participation in gaming communities with shared values
- **Educational Institutions**: Outreach to educational communities interested in community building
- **Professional Networks**: Engagement with professional networks focused on ethical practices
@@ -261,7 +261,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Accommodation Assessment**: Assessment of accessibility needs and accommodation provision
- **Multiple Participation Options**: Information about different ways to participate based on capacity and interest
- **Communication Preferences**: Respect for different communication styles and preferences
- **Flexible Engagement**: Recognition that engagement levels and styles vary amongst community members
- **Flexible Engagement**: Recognition that engagement levels and styles vary among community members
- **Support Systems**: Connection to appropriate support systems and resources
#### 4.1.2. Community Culture Integration
@@ -296,12 +296,12 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Capacity Recognition**: Recognition that participation capacity varies and changes over time
- **Rest and Recovery**: Normalization of breaks and reduced engagement periods
- **Sustainable Volunteerism**: Sustainable approaches to volunteer engagement and responsibility
- **Well-Being Priority**: Prioritisation of member well-being over community productivity
- **Well-Being Priority**: Prioritization of member well-being over community productivity
#### 4.2.2. Community Evolution and Adaptation
**Growth-Responsive Community Development:**
- **Culture Preservation**: Maintaining community culture and values whilst accommodating growth
- **Culture Preservation**: Maintaining community culture and values while accommodating growth
- **Structure Adaptation**: Adapting community structures to serve larger and more diverse membership
- **Democracy Protection**: Ensuring growth doesn't undermine democratic participation and decision-making
- **Quality Maintenance**: Maintaining community quality and values during periods of rapid growth
@@ -332,12 +332,12 @@ This Community Growth Policy establishes ethical guidelines for how community me
- **Social Impact**: Measurement of social impact and community benefit
- **Economic Sustainability**: Sustainable economic approaches to community operations
- **Cultural Sustainability**: Preservation of community culture and values during growth
- **Member Well-Being**: Prioritisation of member well-being in growth planning
- **Member Well-Being**: Prioritization of member well-being in growth planning
#### 5.1.2. Growth Rate Management
**Sustainable Growth Pacing:**
- **Organic Growth Priority**: Prioritisation of organic growth over rapid expansion
- **Organic Growth Priority**: Prioritization of organic growth over rapid expansion
- **Integration Capacity**: Growth that matches community capacity to integrate new members effectively
- **Quality Maintenance**: Growth pacing that maintains community quality and member experience
- **Resource Alignment**: Growth that aligns with available resources and support capacity
@@ -436,7 +436,7 @@ This Community Growth Policy establishes ethical guidelines for how community me
**Long-Term Vision Development:**
- **Community Vision**: Development of long-term vision for community growth and impact
- **Strategic Planning**: Strategic planning for sustainable community development
- **Impact Goals**: Setting and working towards long-term social impact goals
- **Impact Goals**: Setting and working toward long-term social impact goals
- **Innovation Integration**: Planning for integration of emerging technologies and approaches
- **Movement Contribution**: Planning for community contribution to broader social justice movements
src/content/docs/legal/community-support-policy.md
+14 -18
View File
@@ -8,7 +8,7 @@ title: Community Support Policy
### 1.1. Policy Statement
This Community Support Policy establishes the framework for how community members can both seek and provide support within our community ecosystem. This policy is designed to create a safe, inclusive, and mutually supportive environment that honours our values of social justice, accessibility, and community empowerment whilst maintaining appropriate boundaries and safety standards.
This Community Support Policy establishes the framework for how community members can both seek and provide support within our community ecosystem. This policy is designed to create a safe, inclusive, and mutually supportive environment that honours our values of social justice, accessibility, and community empowerment while maintaining appropriate boundaries and safety standards.
### 1.2. Integration with Community Values
@@ -24,6 +24,7 @@ This Community Support Policy establishes the framework for how community member
This policy applies to all forms of support exchange within our community platforms, including:
- Discord channels and direct messages
- Forums and discussion boards
- Reddit community spaces
- Social media interactions
- GitHub collaborative spaces
@@ -62,10 +63,10 @@ This policy applies to all forms of support exchange within our community platfo
- Assistance with community projects and initiatives
- Collaborative problem-solving on shared challenges
- Skill sharing and mentorship opportunities
- Accessibility assistance and accommodation support (request accommodations via our [Accessibility Accommodation Request Form](https://forms.nhcarrigan.com/o/docs/forms/2FXY87PB6aaMHspcnXYCZX/4))
- Accessibility assistance and accommodation support
- Platform-specific guidance and orientation
#### 2.1.2. Specialised Support Areas
#### 2.1.2. Specialized Support Areas
**Identity-Based Support:**
- Support groups for specific identities and experiences
@@ -100,8 +101,9 @@ This policy applies to all forms of support exchange within our community platfo
#### 2.2.1. Identifying Appropriate Support Channels
**Platform-Specific Guidelines:**
- **Discord**: Use designated support channels (#general-support, #tech-help) or reach out to trusted community members
- **Discord Forums**: Create posts in appropriate forum channels with clear, descriptive titles
- **Reddit**: Utilise community-specific support threads and appropriate flair
- **Reddit**: Utilize community-specific support threads and appropriate flair
- **GitHub**: Use issue templates for bug reports, feature requests, and technical support
- **Social Media**: Engage appropriately with community hashtags and threads
@@ -135,12 +137,6 @@ This policy applies to all forms of support exchange within our community platfo
#### 2.2.3. Emergency and Crisis Support
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
**Important Limitations:**
- Community members are **NOT** mental health professionals
- Peer support does **NOT** replace professional mental health services
@@ -162,7 +158,7 @@ We are working very hard to get them in place as soon as possible. If you would
- **Communicate Clearly**: Share what you need and what would be helpful
- **Be Open to Different Perspectives**: Community members bring diverse experiences and viewpoints
- **Respect Advice Boundaries**: Understand the difference between peer support and professional advice
- **Engage Authentically**: Be genuine whilst maintaining appropriate privacy boundaries
- **Engage Authentically**: Be genuine while maintaining appropriate privacy boundaries
- **Follow Through**: Let supporters know how their assistance worked out when appropriate
**Privacy and Safety:**
@@ -311,19 +307,19 @@ We are working very hard to get them in place as soon as possible. If you would
### 4.1. Discord Support Protocols
#### 4.1.1. Channel Organisation and Usage
#### 4.1.1. Channel Organization and Usage
**Designated Support Channels:**
- **#support**: General questions and peer support requests
- **#support-ticket**: Technical assistance and troubleshooting
- **#accessibility**: Accessibility-related assistance and resources (for accommodation requests, use our [Accessibility Accommodation Request Form](https://forms.nhcarrigan.com/o/docs/forms/2FXY87PB6aaMHspcnXYCZX/4))
- **#accessibility**: Accessibility-related assistance and resources
- **Identity-specific channels**: Support spaces for specific communities and identities
**Direct Message Guidelines:**
- **Respect Consent**: Always ask before moving support to direct messages
- **Maintain Documentation**: Keep records of concerning interactions for staff review
- **Escalation Protocols**: Know when and how to involve Discord moderators and staff
- **Privacy Protection**: Respect confidentiality whilst ensuring safety
- **Privacy Protection**: Respect confidentiality while ensuring safety
#### 4.1.2. Discord-Specific Safety Measures
@@ -339,7 +335,7 @@ We are working very hard to get them in place as soon as possible. If you would
**Post Guidelines:**
- **Descriptive Titles**: Clear titles that indicate the type of support needed
- **Appropriate Categorisation**: Use correct flairs and categories for support requests
- **Appropriate Categorization**: Use correct flairs and categories for support requests
- **Privacy Considerations**: Share only what you're comfortable being public
- **Follow-Up Responsibility**: Update threads when situations resolve or change
@@ -466,7 +462,7 @@ We are working very hard to get them in place as soon as possible. If you would
- **Resource Databases**: Comprehensive databases of professional services
- **Referral Processes**: Clear processes for connecting people to professional help
- **Ongoing Coordination**: Coordination between community support and professional services
- **Privacy Compliance**: Respect for privacy whilst ensuring safety
- **Privacy Compliance**: Respect for privacy while ensuring safety
- **Follow-Up Support**: Continued community support alongside professional services
#### 5.2.2. Legal and Ethical Obligations
@@ -503,7 +499,7 @@ We are working very hard to get them in place as soon as possible. If you would
**Feedback and Evaluation:**
- **Community Feedback**: Regular feedback collection from support recipients
- **Peer Evaluation**: Peer feedback amongst support providers
- **Peer Evaluation**: Peer feedback among support providers
- **Staff Review**: Regular staff review of support quality and safety
- **Continuous Improvement**: Ongoing improvement of support practices and resources
- **Training Updates**: Regular updates to support training and resources
@@ -549,7 +545,7 @@ We are working very hard to get them in place as soon as possible. If you would
**Partnership and Collaboration:**
- **Professional Service Partnerships**: Appropriate partnerships with professional service providers
- **Community Organisation Collaboration**: Collaboration with other community organisations
- **Community Organization Collaboration**: Collaboration with other community organisations
- **Resource Sharing Networks**: Participation in resource sharing networks
- **Best Practice Communities**: Participation in communities focused on peer support best practices
- **Research Participation**: Appropriate participation in research on effective community support
src/content/docs/legal/content-moderation.md
+22 -18
View File
@@ -32,7 +32,23 @@ This Policy applies to all content and user interactions across:
### 1.3. Integration with Other Policies
This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Acceptable Use Policy, Limitation of Liability and Indemnification Policy, Service Level Agreement, Export Control and Sanctions Compliance Policy, API Terms and Conditions, and all applicable legal protections by reference.
This Policy operates in conjunction with our comprehensive policy framework:
**(a)** Our Terms of Service, which establish the fundamental legal relationship;
**(b)** Our Community Code of Conduct, which establishes behavioural expectations;
**(c)** Our Acceptable Use Policy, which defines prohibited activities and usage patterns;
**(d)** Our Privacy Policy, which governs data collection and processing in moderation activities;
**(e)** Our Limitation of Liability and Indemnification Policy, which governs all liability and risk allocation matters;
**(f)** Our Service Level Agreement and Warranty Disclaimer, which define service expectations;
**(g)** Our Export Control and Sanctions Compliance Policy, which governs international compliance;
**(h)** Our API Terms and Conditions, which govern developer services;
**(i)** Our Appeals Policy, which provides procedures for challenging moderation decisions;
@@ -242,12 +258,6 @@ Prohibited misinformation and deceptive practices include:
### 4.1. Multi-Layered Moderation System
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
Our moderation approach employs multiple layers:
**(a)** **Automated Detection**: AI and machine learning systems for initial content screening;
@@ -460,7 +470,7 @@ Effective reports should include:
### 6.3. Community Moderation Programme
We establish community moderation programmes that include:
We may establish community moderation programmes that include:
**(a)** **Volunteer Moderators**: Community volunteers who help with content moderation;
@@ -584,12 +594,6 @@ Appeal decisions may result in:
### 8.1. Transparency Reporting
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
We are committed to transparency in our moderation practices through:
**(a)** **Moderation Reports**: Regular reports on moderation activities and statistics;
@@ -924,7 +928,7 @@ For questions about our content policies:
**Subject Line:** Content Policy Inquiry - [Brief Description]
**Response Time:** Within 7-10 business days for policy clarification requests
**Response Time:** Within 3 business days for policy clarification requests
### 12.2. Content Reporting
@@ -936,7 +940,7 @@ To report problematic content:
**Emergency Reports:** For urgent safety concerns, use subject line "URGENT - Content Report"
**Response Time:** Within 7-10 business days for all reports
**Response Time:** Within 24 hours for urgent reports, 48 hours for standard reports
### 12.3. Moderation Appeals
@@ -948,7 +952,7 @@ For appeals of moderation decisions:
**Process:** Follow detailed appeals process outlined in our Community Appeals Policy
**Response Time:** Within 7-10 business days for appeal reviews
**Response Time:** Within 5 business days for appeal reviews
### 12.4. Community Support
@@ -958,7 +962,7 @@ For general community support and guidance:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for community support requests
**Response Time:** Within 48 hours for community support requests
**Live Chat:** Available during business hours for immediate assistance
src/content/docs/legal/crisis-mental-health.md
+8 -14
View File
@@ -28,7 +28,7 @@ This Crisis and Mental Health Management Policy ("Policy") establishes comprehen
This Policy applies to:
**(a)** All Team members (volunteers), Staff (paid employees), and community moderators;
**(a)** All staff members, volunteers, and community moderators;
**(b)** All platforms, services, and communication channels we operate;
@@ -42,7 +42,13 @@ This Policy applies to:
### 1.4. Integration with Other Policies
This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Content and Moderation Policy, and all applicable legal protections by reference.
This Policy operates in conjunction with:
**(a)** Our Content and Moderation Policy, which governs harmful content including self-harm materials;
**(b)** Our Privacy Policy, which governs confidentiality and information sharing;
**(c)** Our Terms of Service, which establish fundamental service limitations;
**(d)** Our Limitation of Liability Policy, which governs risk allocation;
@@ -276,12 +282,6 @@ Our reporting obligations vary by jurisdiction and may include:
### 4.4. Emergency Contact Protocols
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
For immediate emergencies, we maintain:
**(a)** **Emergency Services:** Direct contact information for emergency services in major jurisdictions;
@@ -302,12 +302,6 @@ For immediate emergencies, we maintain:
## 5. RESOURCES AND REFERRALS
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
### 5.1. Crisis Resources Database
We maintain an up-to-date database of:
src/content/docs/legal/dmca.md
+1 -1
View File
@@ -618,7 +618,7 @@ Changes to this Policy will be communicated through:
**(b)** Email notifications to registered users;
**(c)** Community announcements and discussions;
**(c)** Community forum announcements and discussions;
**(d)** Documentation updates with clear change logs.
src/content/docs/legal/export-control.md
+3 -9
View File
@@ -402,12 +402,6 @@ For cloud and remote service provision:
### 6.1. Automated Monitoring Systems
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
We employ automated systems for compliance monitoring including:
**(a)** **Real-Time Screening**: Real-time screening of all user registrations and transactions against sanctions lists;
@@ -824,7 +818,7 @@ For export control and sanctions compliance matters:
**Subject Line:** Export Control Compliance - [Brief Description]
**Response Time:** Within 7-10 business days for compliance inquiries
**Response Time:** Within 24 hours for compliance inquiries
**Emergency Contact:** Available for urgent compliance matters
@@ -836,7 +830,7 @@ For license applications and government relations:
**Subject Line:** Export License Matter - [License Type]
**Response Time:** Within 7-10 business days for licensing matters
**Response Time:** Within 2 business days for licensing matters
**Government Relations:** Dedicated team for government agency coordination
@@ -862,7 +856,7 @@ For export control and sanctions training:
**Training Portal:** Access to online training modules and resources
**Response Time:** Within 7-10 business days for training requests
**Response Time:** Within 3 business days for training requests
---
src/content/docs/legal/government.md
+2 -8
View File
@@ -290,12 +290,6 @@ This report is updated according to the following schedule:
### 7.4. Verification and Accuracy
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
We ensure report accuracy through:
**(a)** **Multi-Source Verification:** Cross-referencing multiple internal sources;
@@ -332,7 +326,7 @@ For media inquiries regarding government actions:
**Email:** press@nhcarrigan.com
**Response Time:** Within 7-10 business days for all matters
**Response Time:** Within 24 hours for urgent matters
### 8.4. User Support
@@ -342,7 +336,7 @@ For users concerned about government access to their data:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for privacy-related inquiries
**Response Time:** Within 48 hours for privacy-related inquiries
## 9. FUTURE DEVELOPMENTS
src/content/docs/legal/liability.md
+17 -5
View File
@@ -12,7 +12,19 @@ This Limitation of Liability and Indemnification Policy ("Policy") establishes c
### 1.2. Integration with Other Legal Documents
This Policy operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Acceptable Use Policy, Service Level Agreement, API Terms and Conditions, and all applicable legal protections by reference.
This Policy operates in conjunction with and supplements:
**(a)** Our Terms of Service, which establish the fundamental user relationship;
**(b)** Our Service Level Agreement, which defines service expectations and remedies;
**(c)** Our Acceptable Use Policy, which defines prohibited activities;
**(d)** Our Privacy Policy, which governs data collection and processing;
**(e)** Our API Terms and Conditions, which govern developer services;
**(f)** Any additional service-specific terms or agreements.
Where conflicts exist between documents, the most restrictive liability limitation shall apply to ensure maximum protection for the Company.
@@ -686,7 +698,7 @@ For questions about liability limitations and legal matters:
**Subject Line:** Liability and Legal Inquiry - [Brief Description]
**Response Time:** Within 7-10 business days for legal inquiries
**Response Time:** Within 5 business days for legal inquiries
**Legal Counsel:** All complex legal matters are reviewed by qualified legal counsel
@@ -700,7 +712,7 @@ For claims potentially subject to liability limitations:
**Notice Requirement:** Formal notice required for all claims seeking damages
**Response Time:** Within 7-10 business days for claim acknowledgement
**Response Time:** Within 10 business days for claim acknowledgement
### 10.3. Insurance and Risk Management
@@ -712,7 +724,7 @@ For insurance and risk management coordination:
**Coverage Questions:** Questions about insurance coverage and risk transfer
**Response Time:** Within 7-10 business days for insurance-related inquiries
**Response Time:** Within 7 business days for insurance-related inquiries
### 10.4. Emergency Legal Matters
@@ -724,7 +736,7 @@ For urgent legal matters requiring immediate attention:
**Phone:** Emergency contact information available to qualified legal representatives
**Response Time:** Within 7-10 business days for all legal matters
**Response Time:** Within 24 hours for emergency legal matters
---
src/content/docs/legal/license.md
+1 -1
View File
@@ -2047,7 +2047,7 @@ For questions, clarifications, or other matters related to this Licence, We may
### 17.1. Primary Communication Channels
#### 17.1.1. Discord Community
#### 17.1.1. Community Forum
Our primary venue for Licence-related discussions and inquiries:
src/content/docs/legal/privacy.md
+11 -13
View File
@@ -192,19 +192,23 @@ Regardless of your location, you have the following rights regarding your person
To exercise any of these rights:
**(a)** Submit requests through our **Privacy Request Form** (Preferred): https://forms.nhcarrigan.com/o/docs/forms/qEJgBWGDfyHv6x51VU9aVX/4
**(a)** Submit requests to **privacy@nhcarrigan.com** from the email address associated with your account;
**(b)** Alternatively, submit requests to **privacy@nhcarrigan.com** from the email address associated with your account;
**(b)** Provide sufficient information to verify your identity;
**(c)** Provide sufficient information to verify your identity;
**(c)** Specify clearly which right you wish to exercise;
**(d)** Specify clearly which right you wish to exercise;
**(e)** Include any relevant details or documentation to support your request.
**(d)** Include any relevant details or documentation to support your request.
### 5.3. Response Timeframes
We endeavour to respond to all privacy requests within 7-10 business days. For complex requests that require additional time, we will notify you and respond within thirty (30) days as required by applicable data protection laws (including GDPR).
We endeavour to respond to all privacy requests within:
**(a)** **Simple requests:** Five (5) business days;
**(b)** **Complex requests:** Thirty (30) days, with notification if additional time is required;
**(c)** **Urgent security matters:** Within twenty-four (24) hours where possible.
### 5.4. Limitations on Rights
@@ -244,12 +248,6 @@ General retention periods include:
### 6.3. Automated Deletion
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
Where technically feasible, we implement automated systems to:
**(a)** Delete information that has exceeded its retention period;
src/content/docs/legal/security.md
+8 -14
View File
@@ -48,8 +48,6 @@ This Policy is designed to operate within the framework of applicable laws and r
If you discover a security vulnerability within any of our systems or applications, please report it exclusively through our designated secure reporting channel:
**Security Vulnerability Report Form** (Preferred): https://forms.nhcarrigan.com/o/docs/forms/wgdbBkS4tjCGoVZTqtmMNx/4
**Primary Contact:** security@nhcarrigan.com
**Subject Line Format:** [SECURITY] Brief description of vulnerability
@@ -174,7 +172,7 @@ Our standard coordinated disclosure timeline follows this process:
**(c)** **Remediation Period:** Development and deployment of fixes (30-90 days depending on complexity);
**(d)** **Public Disclosure:** Joint announcement of vulnerability and resolution (after fix deployment and reasonable notice period). Aggregated and sanitized vulnerability reports are published at: https://security.nhcarrigan.com/report/
**(d)** **Public Disclosure:** Joint announcement of vulnerability and resolution (after fix deployment and reasonable notice period).
### 4.3. Public Acknowledgement
@@ -390,15 +388,13 @@ We utilise a comprehensive suite of security tools integrated into our developme
We maintain transparency about our security posture through publicly accessible security reports and dashboards:
**(a)** **Security Vulnerability Reports:** Aggregated and sanitized security vulnerability reports for all our products are published at: https://security.nhcarrigan.com/report/
**(a)** **Quality Dashboard:** Real-time security and quality metrics available at https://quality.NHCarrigan.link;
**(b)** **Quality Dashboard:** Real-time security and quality metrics available;
**(b)** **Security Reports:** Comprehensive security scan results published at https://security.nhcarrigan.com;
**(c)** **Security Reports:** Comprehensive security scan results published;
**(c)** **Regular Updates:** Weekly scanning cycles ensure up-to-date security information;
**(d)** **Regular Updates:** Weekly scanning cycles ensure up-to-date security information;
**(e)** **Trend Analysis:** Historical data tracking to identify and address security trends over time.
**(d)** **Trend Analysis:** Historical data tracking to identify and address security trends over time.
### 8.5. Security Development Lifecycle
@@ -468,11 +464,9 @@ If vulnerability research reveals potential regulatory compliance issues or lega
For all security-related matters, including vulnerability reports, questions about this Policy, and general security inquiries:
**Security Vulnerability Report Form** (Preferred for vulnerability reports): https://forms.nhcarrigan.com/o/docs/forms/wgdbBkS4tjCGoVZTqtmMNx/4
**Email:** security@nhcarrigan.com
**Response Time:** We aim to respond to all security inquiries within 7-10 business days
**Response Time:** We aim to respond to all security inquiries within 24 hours during business days
**Emergency Contact:** For critical security issues requiring immediate attention, mark your email with [URGENT] in the subject line
@@ -490,11 +484,11 @@ If you are unable to use our primary email contact:
We commit to maintaining the following response standards:
**(a)** **Initial Acknowledgement:** All security reports acknowledged within 7-10 business days;
**(a)** **Initial Acknowledgement:** All security reports acknowledged within 24-72 hours;
**(b)** **Status Updates:** Regular progress updates provided at least weekly for active investigations;
**(c)** **Technical Clarification:** Response to technical questions within 7-10 business days;
**(c)** **Technical Clarification:** Response to technical questions within 2-3 business days;
**(d)** **Escalation Path:** Clear escalation procedures for urgent matters or communication issues.
src/content/docs/legal/sla.md
+15 -13
View File
@@ -12,7 +12,15 @@ This Service Level Agreement and Warranty Disclaimer ("SLA") establishes the ter
### 1.2. Integration with Other Policies
This SLA operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Acceptable Use Policy, and all applicable legal protections by reference.
This SLA supplements and operates in conjunction with:
**(a)** Our Terms of Service, which govern the general terms of service usage;
**(b)** Our Privacy Policy, which governs data collection and processing;
**(c)** Our Acceptable Use Policy, which defines permissible usage patterns;
**(d)** All other applicable policies and agreements.
### 1.3. Scope of Services Covered
@@ -242,7 +250,7 @@ To request Service Level remedies:
**(c)** **Verification**: Allow reasonable time for our team to verify the claim against monitoring data;
**(d)** **Resolution**: We will respond within 7-10 business days with our determination and any applicable remedies.
**(d)** **Resolution**: We will respond within 10 business days with our determination and any applicable remedies.
## 7. FORCE MAJEURE AND EXTERNAL FACTORS
@@ -300,7 +308,7 @@ We maintain comprehensive service monitoring including:
Service status information is communicated through:
**(a)** **Status Page**: Real-time service status available at designated status page at https://uptime.nhcarrigan.com;
**(a)** **Status Page**: Real-time service status available at designated status page;
**(b)** **Incident Updates**: Regular updates during service disruptions or maintenance;
@@ -310,12 +318,6 @@ Service status information is communicated through:
### 8.3. Transparency Reports
:::tip[Heads Up!]{icon=pen}
The policy or policies in this section are still a work in progress. We have not yet implemented the necessary infrastructure to comply with this section.
We are working very hard to get them in place as soon as possible. If you would like to help, consider [applying to join our team!](https://forms.nhcarrigan.com/o/docs/forms/mCxDu3snk9TzFiDjrT4Vc8/4)
:::
We publish regular transparency reports including:
**(a)** **Monthly Availability Reports**: Summary of availability statistics for each service category;
@@ -458,7 +460,7 @@ For questions about this SLA or service level issues:
**Subject Line:** SLA Inquiry - [Brief Description]
**Response Time:** Within 7-10 business days for SLA-related inquiries
**Response Time:** Within 2 business days for SLA-related inquiries
### 14.2. Service Level Remedy Requests
@@ -468,7 +470,7 @@ For Service Level remedy requests:
**Subject Line:** SLA Remedy Request - [Service Name]
**Response Time:** Within 7-10 business days for remedy determinations
**Response Time:** Within 10 business days for remedy determinations
### 14.3. Technical Support
@@ -478,7 +480,7 @@ For general technical support:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for technical support requests
**Response Time:** Within 48 hours for technical support requests
### 14.4. Legal and Compliance Matters
@@ -488,7 +490,7 @@ For legal matters related to this SLA:
**Subject Line:** Legal Matter - SLA
**Response Time:** Within 7-10 business days for legal inquiries
**Response Time:** Within 5 business days for legal inquiries
---
src/content/docs/legal/subprocessors.md
+3 -3
View File
@@ -352,7 +352,7 @@ Regarding data processed by subprocessors, users may:
To exercise rights regarding subprocessor data processing:
**(a)** **Primary Contact:** Submit requests through our **Privacy Request Form** (Preferred): https://forms.nhcarrigan.com/o/docs/forms/qEJgBWGDfyHv6x51VU9aVX/4 or contact us at privacy@nhcarrigan.com for coordination;
**(a)** **Primary Contact:** Contact us at privacy@nhcarrigan.com for coordination;
**(b)** **Direct Contact:** Contact subprocessors directly using their provided channels;
@@ -432,7 +432,7 @@ For questions about subprocessor data processing:
**Subject Line:** Subprocessor Data Processing Inquiry
**Response Time:** Within 7-10 business days for standard inquiries
**Response Time:** Within 5 business days for standard inquiries
### 8.2. Rights Requests
@@ -462,7 +462,7 @@ For technical issues related to third-party platform integrations:
**Discord Community:** https://chat.nhcarrigan.com
**Response Time:** Within 7-10 business days for technical support requests
**Response Time:** Within 48 hours for technical support requests
## 9. COMPLIANCE AND REGULATORY INFORMATION
src/content/docs/legal/terms.md
+1 -1
View File
@@ -392,7 +392,7 @@ All legal notices and formal communications should be sent to:
### 16.3. Business Hours
We endeavour to respond to all inquiries within 7-10 business days during normal business hours (Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time).
We endeavour to respond to all inquiries within forty-eight (48) hours during normal business hours (Monday through Friday, 9:00 AM to 5:00 PM Pacific Standard Time).
---
src/content/docs/mentorship/00-faq.md
+6 -15
View File
@@ -2,21 +2,13 @@
title: 00. Frequently Asked Questions
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**PROVIDING ANSWERS TO FREQUENTLY ASKED QUESTIONS REGARDING THE MENTORSHIP PROGRAMME**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Frequently Asked Questions Documentation (hereinafter referred to as "the FAQ") provides answers to common questions regarding our Mentorship Programme. This FAQ operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Frequently Asked Questions Documentation (hereinafter referred to as "the FAQ") provides answers to common questions regarding our Mentorship Programme. This FAQ operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Purpose and Scope
@@ -40,7 +32,7 @@ This FAQ addresses common questions and concerns regarding programme participati
**Voluntary Donations:**
- We welcome voluntary donations to support programme operations
- Donations are entirely optional and do not affect programme participation or outcomes
- For comprehensive information about donation options and policies, please refer to our [Donation and Support Policy](/about/donate)
- Information about donation options is available at: [https://donate.nhcarrigan.com/](https://donate.nhcarrigan.com/)
## 3. PROGRAMME STRUCTURE AND SUPPORT
@@ -59,7 +51,6 @@ This FAQ addresses common questions and concerns regarding programme participati
- Participants follow documentation and use provided resources independently
- Reviews and approvals are optional and available upon request
- Support is provided when participants ask for help, not through mandatory checkpoints
- **IMPORTANT: To get the most value from the programme experience, participants should actively ask mentors questions as much as possible. Mentors are available to help, but they rely on participants to initiate contact and ask for assistance when needed.**
- Community and peer support is encouraged throughout the programme
### 3.2. Response Time Expectations
@@ -75,9 +66,9 @@ This FAQ addresses common questions and concerns regarding programme participati
**Response Time Guidelines:**
- Most programme activities can be completed independently using provided documentation
- If you have questions, feel free to ask in the #⚗️│alchemy-lab channel
- If you have not received a response within 10 business days, you may send a gentle reminder
- Repeated communications at intervals of less than 10 business days may result in disciplinary action
- If you have questions, feel free to ask in the #mentee-chat channel
- If you have not received a response within three (3) business days, you may send a gentle reminder
- Repeated communications at intervals of less than three (3) days may result in disciplinary action
- We appreciate your patience and understanding regarding response timelines
## 4. PROGRAMME WITHDRAWAL AND DISCONTINUATION
@@ -148,7 +139,7 @@ All expulsion decisions are made in accordance with our Mentorship Programme Ter
- Review the comprehensive mentorship documentation (01-10) for detailed guidance on each programme stage
- Check the resource library for templates, examples, and additional materials
- Contact programme leadership through the designated #⚗️│alchemy-lab channel in our Discord community
- Contact programme leadership through the designated #mentee-chat channel in our Discord community
- Ask community members and alumni for peer support and guidance
- Programme leadership is available to answer questions when asked, but most activities can be completed independently
- Additional information is available in our comprehensive [Mentorship Programme Terms and Conditions](/about/mentorship)
src/content/docs/mentorship/01-onboarding.md
+2 -10
View File
@@ -2,27 +2,19 @@
title: 01. Onboarding
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING ONBOARDING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Onboarding Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for participants accepted into our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Onboarding Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for participants accepted into our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all individuals who have been accepted into our Mentorship Programme. All participants must complete the onboarding procedures set forth in this Documentation to gain full programme access.
**IMPORTANT: This is a self-guided programme. Once you complete onboarding, you can work through the programme documentation at your own pace. Reviews and approvals are optional and available upon request. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided programme. Once you complete onboarding, you can work through the programme documentation at your own pace. Reviews and approvals are optional and available upon request.**
## 2. APPLICATION ACCEPTANCE AND CONFIRMATION
src/content/docs/mentorship/02-goal-setting.md
+4 -12
View File
@@ -2,27 +2,19 @@
title: 02. Goal Setting
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING GOAL-SETTING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Goal-Setting Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for goal-setting activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Goal-Setting Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for goal-setting activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of onboarding procedures. All participants should complete the goal-setting process set forth in this Documentation to proceed with programme activities.
**IMPORTANT: This is a self-guided process. You will create your own roadmap using provided templates and examples. No approval is required to proceed. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will create your own roadmap using provided templates and examples. No approval is required to proceed.**
## 2. GOAL-SETTING INITIATION
@@ -32,7 +24,7 @@ Goal-setting procedures must be initiated following completion of onboarding pro
### 2.2. Goal-Setting Forum Post Creation
**Required Action:** Create a thread in the #🎯│oaths forum channel on our Discord community.
**Required Action:** Create a thread in the #goal-setting forum channel on our Discord community.
**Thread Naming Convention:**
```markdown
@@ -71,7 +63,7 @@ Goal-setting procedures must be initiated following completion of onboarding pro
### 2.4. Optional Feedback and Clarification
If you would like feedback on your goal-setting post or have questions about creating your roadmap, you can:
- Ask questions in the #⚗️│alchemy-lab channel in Discord
- Ask questions in the #mentee-chat channel in Discord
- Request feedback from programme leadership or community members
- Review roadmap templates and examples in the resource library
- Proceed independently if you feel confident in your goals and plan
src/content/docs/mentorship/03-project-plan.md
+5 -13
View File
@@ -2,27 +2,19 @@
title: 03. Project Planning
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING PROJECT PLANNING PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Project Planning Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for flagship project planning within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Project Planning Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for flagship project planning within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of goal-setting procedures. All participants should complete the project planning process set forth in this Documentation to proceed with flagship project development.
**IMPORTANT: This is a self-guided process. You will create your own project plan using provided examples and templates. No approval is required to proceed. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will create your own project plan using provided examples and templates. No approval is required to proceed.**
## 2. PROJECT PLANNING INITIATION
@@ -32,7 +24,7 @@ Project planning procedures must be initiated following completion of goal-setti
### 2.2. Project Planning Forum Post Creation
**Required Action:** Create a post in the #🗺️│quest-board forum channel on our Discord community.
**Required Action:** Create a post in the #project-plan forum channel on our Discord community.
**Post Naming Convention:**
```markdown
@@ -59,7 +51,7 @@ Project planning procedures must be initiated following completion of goal-setti
**Project Idea Assistance:**
- If you do not yet have a project idea, create your post with a statement such as: "I need help brainstorming a project idea"
- Review project idea examples in the resource library for inspiration
- Ask for help in the #⚗️│alchemy-lab channel if you'd like community input
- Ask for help in the #mentee-chat channel if you'd like community input
- Programme leadership and community members can provide feedback if requested
- You can also proceed independently by researching project ideas online or adapting examples
@@ -76,7 +68,7 @@ Once your project planning post is created, you will develop your project plan i
- Create a detailed project plan ready for development work
**Optional Support:**
- If you need help brainstorming or refining your project idea, ask in the #⚗️│alchemy-lab channel
- If you need help brainstorming or refining your project idea, ask in the #mentee-chat channel
- Community members and programme leadership can provide feedback if requested
- You can proceed independently once you have a project concept you're happy with
src/content/docs/mentorship/04-user-stories.md
+3 -11
View File
@@ -2,27 +2,19 @@
title: 04. User Stories
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING USER STORY DEVELOPMENT PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This User Stories Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for user story development within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This User Stories Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for user story development within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of project planning procedures. All participants should complete the user story development process set forth in this Documentation to proceed with technical breakdown and development stages.
**IMPORTANT: This is a self-guided process. You will create user stories independently using provided templates and examples. No review or approval is required to proceed. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will create user stories independently using provided templates and examples. No review or approval is required to proceed.**
## 2. USER STORY DEVELOPMENT REQUIREMENTS
@@ -101,7 +93,7 @@ Separate issues provide:
**Optional Review:**
- If you would like feedback on your user stories, you can:
- Request review in the #⚗️│alchemy-lab channel in Discord
- Request review in the #mentee-chat channel in Discord
- Ask community members or alumni for peer review
- Review user story examples in the resource library for comparison
- Reviews are optional and available upon request, not required
src/content/docs/mentorship/05-technical-breakdown.md
+3 -11
View File
@@ -2,27 +2,19 @@
title: 05. Technical Breakdown
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING TECHNICAL BREAKDOWN PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Technical Breakdown Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for technical breakdown activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Technical Breakdown Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for technical breakdown activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of user story development procedures. All participants should complete the technical breakdown process set forth in this Documentation to proceed with development work.
**IMPORTANT: This is a self-guided process. You will fill out technical breakdown templates independently for each user story. No review or approval is required to proceed. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will fill out technical breakdown templates independently for each user story. No review or approval is required to proceed.**
## 2. TECHNICAL BREAKDOWN INITIATION
@@ -191,7 +183,7 @@ Complete the technical breakdown template for each user story. Completion includ
**Optional Review:**
- If you would like feedback on your technical breakdowns, you can:
- Request review in the #⚗️│alchemy-lab channel in Discord
- Request review in the #mentee-chat channel in Discord
- Ask community members or alumni for peer review
- Review technical breakdown examples in the resource library for comparison
src/content/docs/mentorship/06-priority-and-effort.md
+3 -11
View File
@@ -2,27 +2,19 @@
title: 06. Priority and Effort
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING PRIORITY AND EFFORT ASSIGNMENT PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Priority and Effort Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for priority and effort assignment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Priority and Effort Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for priority and effort assignment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of technical breakdown procedures. All participants should complete the priority and effort assignment process set forth in this Documentation to proceed with development work.
**IMPORTANT: This is a self-guided process. You will assign priority and effort labels independently. No review or approval is required to proceed. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will assign priority and effort labels independently. No review or approval is required to proceed.**
## 2. LABEL CREATION AND ASSIGNMENT
@@ -141,7 +133,7 @@ The purpose of applying effort labels is to help plan work timelines and resourc
**Optional Review:**
- If you would like feedback on your priority and effort assignments, you can:
- Request review in the #⚗️│alchemy-lab channel in Discord
- Request review in the #mentee-chat channel in Discord
- Ask community members or alumni for peer review
- Review priority and effort examples in the resource library for comparison
- Reviews are optional and available upon request, not required
src/content/docs/mentorship/07-writing-code.md
+5 -15
View File
@@ -2,27 +2,19 @@
title: 07. Writing Code
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING CODE DEVELOPMENT PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Writing Code Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for code development activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, Contributor Covenant, and all applicable legal protections by reference.
This Writing Code Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for code development activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, Contributor Covenant, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme following completion of priority and effort assignment procedures. All participants should comply with the code development procedures set forth in this Documentation.
**IMPORTANT: Whilst developing your flagship project, you must comply with our [Community Code of Conduct](/community/coc) and [Community Guidelines](/community/guide). Your mentorship repository must not be used for any code or non-code content or behaviour that is illegal, harmful to others, discriminatory, or bigoted. See Section 7.3 for details on intellectual property and style standards. Code reviews are optional and available upon request, not mandatory.**
**IMPORTANT: Code development should comply with our Style Guide, Contributor Covenant, and all applicable development standards. Code reviews are optional and available upon request, not mandatory.**
## 2. DEVELOPMENT WORKFLOW REQUIREMENTS
@@ -71,7 +63,7 @@ Before writing code, participants must consider and address the requirements set
- Community members and alumni may also provide peer reviews if requested
**Requesting Reviews:**
- If you would like a code review, request one in the #⚗️│alchemy-lab channel or tag programme leadership on your PR
- If you would like a code review, request one in the #mentee-chat channel or tag programme leadership on your PR
- Reviews are provided when available, not guaranteed immediately
- You can proceed with development while waiting for reviews
@@ -177,11 +169,9 @@ This Documentation establishes code development procedures and requirements. How
- Programme leadership is not responsible for participants' ability to complete development work
- Individual results may vary based on participant skill, effort, and other factors
### 7.3. Intellectual Property Ownership
### 7.3. Intellectual Property Considerations
**Your flagship project belongs to you.** NHCarrigan makes no claim to intellectual property rights over projects developed during the Mentorship Programme. You own your project outright and are free to licence it however you choose.
**Regarding style standards:** Our Style Guide applies only to contributions to NHCarrigan-maintained repositories — it does not apply to your flagship project. You are entirely free to choose your own coding style, linting tools, licence, and copyright attribution for your own project.
All code developed as part of the Mentorship Programme is subject to our Mentorship Programme Terms and Conditions regarding intellectual property rights. Participants should familiarise themselves with these terms before beginning development work.
## 8. CONCLUSION
src/content/docs/mentorship/08-final-polish.md
+7 -15
View File
@@ -2,27 +2,19 @@
title: 08. Final Polish
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING FINAL POLISH AND DEPLOYMENT PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Final Polish Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for final project polish, documentation, and deployment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Final Polish Documentation (hereinafter referred to as "the Documentation") establishes mandatory procedures and requirements for final project polish, documentation, and deployment within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme whose flagship projects have reached a state suitable for resume presentation. All participants should complete the final polish procedures set forth in this Documentation before project completion.
**IMPORTANT: This is a self-guided process. You will use provided checklists and templates to polish your project independently. Reviews and approvals are optional and available upon request. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will use provided checklists and templates to polish your project independently. Reviews and approvals are optional and available upon request.**
## 2. FINAL POLISH INITIATION
@@ -36,7 +28,7 @@ When you believe your flagship project has reached a state where it can be proud
- Begin addressing items on the checklist independently
**Optional Support:**
- If you would like feedback on project readiness, ask in the #⚗️│alchemy-lab channel
- If you would like feedback on project readiness, ask in the #mentee-chat channel
- Programme leadership or community members can provide guidance if requested
- You can proceed independently using the provided resources
@@ -54,10 +46,10 @@ When you believe your flagship project has reached a state where it can be proud
- Code quality and maintainability
- Best practices and industry standards
- Security considerations
- Performance optimisation
- Performance optimization
- Error handling
- Test coverage
- Code organisation and structure
- Code organization and structure
### 3.2. Issue Resolution
@@ -89,7 +81,7 @@ Use the provided documentation templates and examples in the resource library to
- End user documentation examples
**Optional Support:**
- If you need help with documentation, ask in the #⚗️│alchemy-lab channel
- If you need help with documentation, ask in the #mentee-chat channel
- Programme leadership or community members can provide guidance if requested
- You can proceed independently using the provided templates
@@ -171,7 +163,7 @@ You should deploy a live version of your application for professional presentati
- Free options may not always be viable depending on project requirements
**Optional Support:**
- If you encounter issues during deployment, ask for help in the #⚗️│alchemy-lab channel
- If you encounter issues during deployment, ask for help in the #mentee-chat channel
- Programme leadership or community members can provide guidance if requested
- Most deployment can be completed independently using the provided guides
src/content/docs/mentorship/09-career-prep.md
+6 -14
View File
@@ -2,27 +2,19 @@
title: 09. Career Prep
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING CAREER PREPARATION PROCEDURES AND REQUIREMENTS FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Career Preparation Documentation (hereinafter referred to as "the Documentation") establishes procedures and requirements for career preparation activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Career Preparation Documentation (hereinafter referred to as "the Documentation") establishes procedures and requirements for career preparation activities within our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
This Documentation applies to all participants in our Mentorship Programme who are ready to begin their job search. Career preparation resources and support are available as set forth in this Documentation.
**IMPORTANT: This is a self-guided process. You will use provided resources, templates, and guides to prepare for your job search independently. Support is available upon request, but most activities can be completed using the resource library. For comprehensive information about the self-guided programme structure and how to get the most value from your mentorship experience, please refer to our [Mentorship Programme Terms and Conditions](/about/mentorship).**
**IMPORTANT: This is a self-guided process. You will use provided resources, templates, and guides to prepare for your job search independently. Support is available upon request, but most activities can be completed using the resource library.**
## 2. CAREER PREPARATION RESOURCES
@@ -71,7 +63,7 @@ Upon reaching the career preparation stage, you have access to comprehensive res
- Present your project effectively on your resume
**Optional Review:**
- If you would like feedback on your resume, request a review in the #⚗️│alchemy-lab channel
- If you would like feedback on your resume, request a review in the #mentee-chat channel
- Programme leadership or community members can provide feedback if requested
- Reviews are optional and available upon request
@@ -100,7 +92,7 @@ LinkedIn profile preparation should focus on:
- Optimizing profile for recruiter visibility
**Optional Review:**
- If you would like feedback on your LinkedIn profile, request a review in the #⚗️│alchemy-lab channel
- If you would like feedback on your LinkedIn profile, request a review in the #mentee-chat channel
- Programme leadership or community members can provide feedback if requested
- Reviews are optional and available upon request
@@ -134,7 +126,7 @@ LinkedIn profile preparation should focus on:
- Review application content using provided checklists
**Optional Support:**
- If you would like feedback on your applications, request a review in the #⚗️│alchemy-lab channel
- If you would like feedback on your applications, request a review in the #mentee-chat channel
- Programme leadership or community members can provide feedback if requested
- Support is limited to guidance and feedback on application content
- You are responsible for submitting your own applications
@@ -161,7 +153,7 @@ LinkedIn profile preparation should focus on:
**Mock Interview Availability:**
- Mock interviews are available upon request when programme leadership or community members are available
- Request mock interviews in the #⚗️│alchemy-lab channel
- Request mock interviews in the #mentee-chat channel
- Mock interviews prepare you for real interview situations
- Feedback and coaching on interview performance may be provided
src/content/docs/mentorship/10-graduation.md
+1 -9
View File
@@ -2,21 +2,13 @@
title: 10. Graduation
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ESTABLISHING GRADUATION CRITERIA AND ALUMNI PROGRAMME PROCEDURES FOR MENTORSHIP PROGRAMME PARTICIPANTS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Graduation Documentation (hereinafter referred to as "the Documentation") establishes graduation criteria, procedures, and alumni programme information for our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
This Graduation Documentation (hereinafter referred to as "the Documentation") establishes graduation criteria, procedures, and alumni programme information for our Mentorship Programme. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Community Code of Conduct, Mentorship Programme Terms and Conditions, and all applicable legal protections by reference.
### 1.2. Scope and Applicability
src/content/docs/mentorship/resources/career-prep.md
-8
View File
@@ -2,14 +2,6 @@
title: Career Preparation Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**RESUME TEMPLATES, LINKEDIN GUIDES, APPLICATION GUIDES, INTERVIEW RESOURCES, AND JOB SEARCH STRATEGIES**
## Resume Templates
src/content/docs/mentorship/resources/code-development.md
+9 -17
View File
@@ -2,14 +2,6 @@
title: Code Development Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**CODE REVIEW CHECKLIST, SELF-REVIEW GUIDELINES, AND BEST PRACTICES**
## Code Review Checklist
@@ -32,7 +24,7 @@ See [Code Review Checklist](/mentorship/resources/code-review-checklist) for the
### Self-Review Questions
**Code Quality:**
- Is my code readable and well-organised?
- Is my code readable and well-organized?
- Are variable and function names clear?
- Is the code properly commented?
- Does the code follow project conventions?
@@ -46,7 +38,7 @@ See [Code Review Checklist](/mentorship/resources/code-review-checklist) for the
**Testing:**
- Are tests written and passing?
- Is test coverage adequate?
- Do tests actually test behaviour?
- Do tests actually test behavior?
**Security:**
- Is sensitive data protected?
@@ -63,7 +55,7 @@ See [Code Review Checklist](/mentorship/resources/code-review-checklist) for the
- Write self-documenting code
- Add comments for complex logic
**Organisation:**
**Organization:**
- Follow project structure conventions
- Group related code together
- Separate concerns appropriately
@@ -120,12 +112,12 @@ See [Code Review Checklist](/mentorship/resources/code-review-checklist) for the
### Performance
**Optimisation:**
- Profile before optimising
- Optimise database queries
**Optimization:**
- Profile before optimizing
- Optimize database queries
- Minimize API calls
- Use caching where appropriate
- Optimise assets (images, CSS, JS)
- Optimize assets (images, CSS, JS)
### Documentation
@@ -161,9 +153,9 @@ See [Code Review Checklist](/mentorship/resources/code-review-checklist) for the
### Testing Issues
❌ **No tests:** Always write tests
❌ **Weak tests:** Test actual behaviour
❌ **Weak tests:** Test actual behavior
❌ **Ignoring failing tests:** Fix them
❌ **Testing implementation:** Test behaviour
❌ **Testing implementation:** Test behavior
### Security Issues
src/content/docs/mentorship/resources/code-review-checklist.md
+1 -9
View File
@@ -2,14 +2,6 @@
title: Code Review Checklist
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**SELF-REVIEW CHECKLIST FOR CODE QUALITY**
Use this checklist to review your own code before merging pull requests or when preparing for optional code reviews.
@@ -17,7 +9,7 @@ Use this checklist to review your own code before merging pull requests or when
## Code Quality
- [ ] Code follows project style guide and conventions
- [ ] Code is readable and well-organised
- [ ] Code is readable and well-organized
- [ ] Variable and function names are clear and descriptive
- [ ] Code is properly commented where necessary
- [ ] No commented-out code or debugging statements left in
src/content/docs/mentorship/resources/final-polish-checklist.md
+4 -12
View File
@@ -2,14 +2,6 @@
title: Final Polish Checklist
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**COMPREHENSIVE CHECKLIST FOR PROJECT FINAL POLISH**
Use this checklist to ensure your flagship project is ready for professional presentation.
@@ -17,7 +9,7 @@ Use this checklist to ensure your flagship project is ready for professional pre
## Code Quality
- [ ] All code follows project style guide
- [ ] Code is clean, readable, and well-organised
- [ ] Code is clean, readable, and well-organized
- [ ] No commented-out code or debugging statements
- [ ] Error handling is comprehensive
- [ ] Code is properly commented where necessary
@@ -85,10 +77,10 @@ Use this checklist to ensure your flagship project is ready for professional pre
## Project Organization
- [ ] Repository structure is clean and logical
- [ ] Files are properly organised
- [ ] Files are properly organized
- [ ] Git history is clean and meaningful
- [ ] Issues are properly labelled and organised
- [ ] Project board is organised (if used)
- [ ] Issues are properly labeled and organized
- [ ] Project board is organized (if used)
## Professional Presentation
src/content/docs/mentorship/resources/final-polish.md
+4 -12
View File
@@ -2,14 +2,6 @@
title: Final Polish Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**FINAL POLISH CHECKLIST, CODE CLEANUP GUIDELINES, DOCUMENTATION TEMPLATES, AND DEPLOYMENT GUIDES**
## Final Polish Checklist
@@ -29,18 +21,18 @@ See [Final Polish Checklist](/mentorship/resources/final-polish-checklist) for t
- Add missing comments
- Fix code style inconsistencies
### Code Organisation
### Code Organization
**Structure:**
- Organise files logically
- Organize files logically
- Group related functionality
- Separate concerns appropriately
- Follow project conventions
- Remove duplicate code
### Performance Optimisation
### Performance Optimization
**Optimise:**
**Optimize:**
- Database queries
- API calls
- Asset loading
src/content/docs/mentorship/resources/goal-setting.md
-8
View File
@@ -2,14 +2,6 @@
title: Goal Setting Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**ROADMAP TEMPLATES AND GOAL-SETTING RESOURCES**
## Roadmap Templates
src/content/docs/mentorship/resources/priority-effort.md
-8
View File
@@ -2,14 +2,6 @@
title: Priority and Effort Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**PRIORITY ASSIGNMENT AND EFFORT ESTIMATION GUIDES**
## Priority Assignment Guide
src/content/docs/mentorship/resources/project-planning.md
+4 -12
View File
@@ -2,14 +2,6 @@
title: Project Planning Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**PROJECT PLAN EXAMPLES AND BRAINSTORMING GUIDES**
## Project Plan Example
@@ -17,14 +9,14 @@ Being active in my [Discord community](https://chat.nhcarrigan.com/) increases y
### Example: Task Management Application
**Project Overview:**
A full-stack task management application that allows users to create, organise, and track tasks with features like kanban boards, task dependencies, and project rewards.
A full-stack task management application that allows users to create, organize, and track tasks with features like kanban boards, task dependencies, and project rewards.
**Core Features:**
1. User authentication and authorization
2. Task creation and management
3. Kanban board view
4. Task dependencies
5. Project organisation
5. Project organization
6. Reward system for completed projects
7. Gamification elements (optional)
@@ -64,7 +56,7 @@ A full-stack task management application that allows users to create, organise,
**Examples:**
- Daily life: Meal planning, expense tracking, habit tracking
- Tools: Code snippet manager, design asset organiser
- Tools: Code snippet manager, design asset organizer
- Hobbies: Music playlist creator, workout tracker, recipe manager
- Industries: Healthcare apps, education tools, productivity software
@@ -74,7 +66,7 @@ A full-stack task management application that allows users to create, organise,
"As a [user type], I need [what they need] because [why they need it]."
**Example:**
"As a developer, I need a way to organise and quickly access my code snippets because I waste time searching through notes and documentation."
"As a developer, I need a way to organize and quickly access my code snippets because I waste time searching through notes and documentation."
### Step 3: Identify Core Features
src/content/docs/mentorship/resources/technical-breakdown.md
-8
View File
@@ -2,14 +2,6 @@
title: Technical Breakdown Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**TECHNICAL BREAKDOWN TEMPLATE AND EXAMPLES**
## Technical Breakdown Template
src/content/docs/mentorship/resources/user-stories.md
+3 -11
View File
@@ -2,14 +2,6 @@
title: User Story Resources
---
:::caution[Programme Sunset]
The open Mentorship Programme has been sunset and is no longer accepting new participants. These pages remain available as reference material.
I'm now running a private, personalised professional development programme on an invite-only basis - hand-selecting a small number of participants so the shape of each journey can be built around them. There is no application process; participation is by direct invitation only.
Being active in my [Discord community](https://chat.nhcarrigan.com/) increases your chances of being invited.
:::
**USER STORY TEMPLATES, EXAMPLES, AND WRITING GUIDES**
## User Story Format
@@ -84,7 +76,7 @@ As an authenticated user, I can create a new task so that I can track work that
As an authenticated user, I can mark a task as complete so that I can track my progress.
**Example 3:**
As an authenticated user, I can organise tasks into projects so that I can group related work.
As an authenticated user, I can organize tasks into projects so that I can group related work.
**Example 4:**
As an authenticated user, I can set task dependencies so that I can ensure tasks are completed in the correct order.
@@ -183,7 +175,7 @@ As an authenticated user, I can delete [resource] so that [value].
- Edit content
- Delete content
- Search/filter content
- Organise content
- Organize content
### Social Features
@@ -213,5 +205,5 @@ As an authenticated user, I can delete [resource] so that [value].
---
*User stories should be clear, focused, and user-centred. They guide development by keeping the focus on user value.*
*User stories should be clear, focused, and user-centered. They guide development by keeping the focus on user value.*
src/content/docs/misc/music.md
+94
View File
@@ -0,0 +1,94 @@
---
title: Managing Local Music
---
**DOCUMENTING LOCAL MUSIC LIBRARY MANAGEMENT PROCEDURES**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Music Management Documentation (hereinafter referred to as "the Documentation") provides technical procedures and instructions for managing local music libraries on Linux systems. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Purpose and Scope
This Documentation describes technical procedures for managing local music libraries. This information is provided for informational purposes and personal use only.
**IMPORTANT: Users are solely responsible for ensuring that all music acquisition, storage, and management activities comply with applicable copyright laws, licensing agreements, and legal requirements. Our organisation does not condone or support any illegal activities, including copyright infringement or piracy.**
### 1.3. Legal Compliance Disclaimer
All users must ensure that their music acquisition and management activities comply with:
- Applicable copyright laws and regulations
- Terms of service of music platforms and services
- Licensing agreements for music content
- All relevant intellectual property laws
Our organisation assumes no responsibility for any illegal activities conducted using information from this Documentation.
## 2. ACQUIRING MUSIC
You are welcome to use any method you wish to *LEGALLY* acquire music. We would never encourage the criminal act of piracy. But maybe you're an artist and you want to archive or back up your own music - in that case, here you go:
```bash
yt-dlp -x --audio-format mp3 <url> --cookies-from-browser firefox
```
Omit the `--cookies-from-browser firefox` if you do not need authentication (auth is required for age-restricted content, for example).
## 3. EDITING METADATA
The specific meta tags you may need to set will vary depending on the music software you use. We have confirmed that `TIT2` is read as the title and `TPE1` is read as the artist when using Amberol on Linux and Musicolet on Android. Using `-t` and `-a` might work.
```bash
id3v2 "/path/to/song" --TIT2 "Song Title" --TPE1 "Song Artist"
```
## 4. ADDING COVER IMAGES
Download the image (we have confirmed JPEGs work) that you want to apply to the song, then run:
```bash
eyeD3 --add-image="/path/to/img":FRONT_COVER "/path/to/mp3"
```
## 5. COPYING TO ANDROID DEVICES
You'll need to replace your paths and your device ID to match your local setup, but:
```bash
adb -s 192.168.12.105:5555 push music/* /storage/self/primary/Music
```
## 6. LIMITATION OF LIABILITY AND DISCLAIMERS
### 6.1. Reference to Comprehensive Liability Framework
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
### 6.2. Legal Compliance Disclaimer
This Documentation provides technical procedures only. Our organisation:
- Does not provide legal advice regarding music acquisition or copyright compliance
- Does not endorse or support any illegal activities, including copyright infringement
- Assumes no responsibility for users' compliance with copyright laws or licensing agreements
- Recommends that users consult qualified legal counsel for questions about copyright compliance
### 6.3. Technical Accuracy Disclaimer
While we strive to maintain accurate and current information in this Documentation, software tools, commands, and procedures may change over time. Users are responsible for:
- Verifying current software versions and compatibility
- Adapting procedures to their specific system configurations
- Ensuring their technical setup meets the requirements for these procedures
- Consulting additional resources for the most current technical information
## 7. CONCLUSION
This Music Management Documentation provides technical procedures for managing local music libraries on Linux systems. All users must ensure that their use of these procedures complies with applicable copyright laws, licensing agreements, and legal requirements.
---
*For questions about music management procedures or legal compliance, please consult qualified legal counsel.*
src/content/docs/misc/prompts.md
+151
View File
@@ -0,0 +1,151 @@
---
title: AI Prompts
---
**DOCUMENTING STANDARD AI PROMPTS AND WORKFLOW TEMPLATES**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This AI Prompts Documentation (hereinafter referred to as "the Documentation") provides standard prompts, templates, and workflow instructions for using artificial intelligence tools in our organisational workflows. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Purpose and Scope
This Documentation serves as a reference for standardised AI prompts used in various organisational contexts. These prompts are provided for convenience and consistency but may require customisation for specific use cases.
**IMPORTANT: These prompts are provided as starting points and may require modification to meet specific requirements. Users are responsible for ensuring that any use of AI tools complies with applicable laws, regulations, and organisational policies.**
### 1.3. AI Tool Usage Disclaimer
Our organisation does not guarantee the accuracy, reliability, or appropriateness of outputs generated using these prompts. Users are responsible for:
- Reviewing and validating all AI-generated content
- Ensuring compliance with applicable laws and regulations
- Maintaining appropriate oversight of AI tool usage
- Protecting sensitive or confidential information when using AI tools
## 2. AI PROMPTS
### 2.1. Documentation Generation Prompt
Open Claude Code in your project directory, then provide this prompt:
```md
Please go through the entire `src` directory and use the codebase to generate documentation for me, given the following template:
---
title: <app name>
---
<app name> (hereinafter the "Application") is <description>
## 1. User Documentation
This section is for those interacting with a live instance of the Application.
## 2. Technical Documentation
This section is for those interested in running their own instance of the Application.
## 3. Legal Documentation
This section is for expansions to our legal policies specific to the Application.
## 4. Contributing Documentation
This section is for documentation related to contributing to the Application's codebase.
```
### 2.2. Comprehension Question Generation Prompt
We use this for some of our client work, but this is great for creating questions to quiz yourself on any document you've read.
````md
You must create three comprehension check questions for the lecture script the user provides. Do not include any other information. Format the response as a code block so the user can easily copy the syntax.
Here is the format:
```
### Question 1:
Which of the following is a key characteristic of relational databases?
**A.** Flexible schema
**B.** Document-based structure
**C.** Key-value pairs
**D.** Structured data in tables
Hint: Think about how data is organised in relational databases.
Answer: **D.** Structured data in tables
### Question 2:
Which of the following is a key characteristic of relational databases?
**A.** Flexible schema
**B.** Document-based structure
**C.** Key-value pairs
**D.** Structured data in tables
Hint: Think about how data is organised in relational databases.
Answer: **D.** Structured data in tables
### Question 3:
Which of the following is a key characteristic of relational databases?
**A.** Flexible schema
**B.** Document-based structure
**C.** Key-value pairs
**D.** Structured data in tables
Hint: Think about how data is organised in relational databases.
Answer: **D.** Structured data in tables
```
````
## 3. LIMITATION OF LIABILITY AND DISCLAIMERS
### 3.1. Reference to Comprehensive Liability Framework
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
### 3.2. AI Tool Usage Disclaimer
These prompts are provided for informational purposes only. Our organisation:
- Does not guarantee the accuracy, reliability, or appropriateness of outputs generated using these prompts
- Does not warrant that these prompts will produce desired results in all contexts
- Assumes no responsibility for outcomes resulting from the use of these prompts with AI tools
- Recommends that users review and validate all AI-generated content
### 3.3. User Responsibilities
Users are responsible for:
- Reviewing and validating all AI-generated content before use
- Ensuring compliance with applicable laws, regulations, and organisational policies
- Protecting sensitive or confidential information when using AI tools
- Maintaining appropriate oversight and quality control of AI tool usage
- Adapting prompts to meet specific requirements and contexts
## 4. CONCLUSION
This AI Prompts Documentation provides standardised prompts and workflow templates for using artificial intelligence tools in our organisational workflows. All users are responsible for ensuring that their use of these prompts complies with applicable laws, regulations, and organisational policies, and for maintaining appropriate oversight of AI tool usage.
---
*For questions about AI prompt usage or to suggest improvements, please contact appropriate organisational leadership through designated communication channels.*
src/content/docs/misc/templates.md
+318
View File
@@ -0,0 +1,318 @@
---
title: Templates
---
**PROVIDING STANDARD TEMPLATES AND DOCUMENTATION FORMS**
## 1. INTRODUCTION AND LEGAL FRAMEWORK
### 1.1. Policy Overview
This Templates Documentation (hereinafter referred to as "the Documentation") provides standard templates, forms, and documentation formats used throughout our organisation. This Documentation operates within our comprehensive legal and policy framework, incorporating our Terms of Service, Privacy Policy, and all applicable legal protections by reference.
### 1.2. Purpose and Scope
This Documentation serves as a reference for standardised templates used in various organisational contexts. These templates are provided for convenience and consistency but may require customisation for specific use cases.
**IMPORTANT: These templates are provided as starting points and may require modification to meet specific legal, regulatory, or contextual requirements. Users are responsible for ensuring that any use of these templates complies with applicable laws and regulations.**
### 1.3. Disclaimer
Our organisation does not provide legal advice. These templates are provided for informational purposes only. Users should consult with qualified legal counsel when using these templates for legal matters or when compliance with specific regulations is required.
## 2. TEMPLATES
### 2.1. DMCA Takedown Template
```md
To whom it may concern:
We are writing to notify you of the copyright infringement and unlawful use of our copyrighted material that appear on the service for which you are the designated agent.
The infringing material, which we contend belong to us, includes our original visual assets.
The infringing material appears at the following location(s):
<url>
The original material is available at the following location(s):
<url>
This letter is the official notification under Section 512(c) of the Digital Millennium Copyright Act of 1998 ("DMCA") and we request the immediate removal of the aforementioned infringing materials from your servers.
We also request that you immediately notify the infringer of this notice and inform them to cease any further posting of the infringing material to your server in the future.
We are providing this notice in good faith and with the reasonable belief that we are the copyright holder of the material, and that the use of the described material in the manner complained is not authorised by us, our agents, or the law.
We swear, under penalty of perjury, that the information in this notification is accurate and that we are the owner of the copyrighted material involved.
If you have any questions, please feel free to reach out to us.
```
### 2.2. LinkedIn Cold Outreach Response Template
```md
I would be more than happy to chat! You can schedule time directly on my calendar:
https://zcal.co/nhcarrigan/meet
```
### 2.3. LinkedIn Post-Event Recommendation Template
```md
I had the absolute pleasure of working with [Participant's Name] during our [event name], where [they] consistently impressed me with [their] dedication, technical growth, and collaborative spirit.
From the start, [Participant's Name] dove into the challenge with enthusiasm, applying [their] skills in [tech stack] to build real, impactful solutions. Whether working independently or as part of a team, [they] brought thoughtful ideas, clear communication, and a passion for learning that elevated everyone around [them].
The value of [Participant's Name]'s contributions are immeasurable. Throughout the event, they [explain loads of goals here].
By the end of the [event name], [Participant's Name] had delivered an outstanding project: [project name or brief description]. More than the final product, what stood out was [their] journey—embracing feedback, overcoming obstacles, and supporting others along the way.
I wholeheartedly recommend [Participant's Name] for any opportunity in tech. [They] bring not just technical ability, but the kind of energy and curiosity that makes any team stronger.
```
### 2.4. LinkedIn Mentorship Recommendation Template
```md
I had the privilege of mentoring [Mentee's Name] through my 1:1 mentorship programme, and from our very first session, it was clear that [they] approached learning with curiosity, determination, and an eagerness to grow.
Over the course of the programme, [Mentee's Name] set clear goals and worked diligently toward them—building both technical skills in [specific tech stack, tools, or concepts] and the professional confidence to apply those skills in real-world scenarios. [They] embraced feedback, sought out challenges, and consistently demonstrated the resilience needed to push past obstacles.
What impressed me most was [their] commitment to personal and professional growth—not just in terms of technical ability, but also in communication, collaboration, and problem-solving. By the end of the mentorship, [Mentee's Name] had successfully delivered [describe final project or achievement], showing not only technical proficiency but also the ability to think critically and adapt to new situations.
I am confident that [Mentee's Name] will continue to excel in their career. They bring the kind of focus, curiosity, and dedication that make them a valuable asset to any team, and I am proud to have played a part in their journey.
```
### 2.5. Form Submission Declined Email Template
```md
Hello,
Thank you for your submission to our <form> form.
We appreciate your interest in working with us. However, at this time we are not able to accept your submission.
Please note that due to the large volume of form submissions we process, we are unable to provide personalised feedback. Here are some common submission issues we see:
1. Low-effort Submission: Please ensure you are taking the time to provide detailed, well-thought responses. The more effort you put in, the more likely we will be able to accept it.
2. Invalid Discord ID: Many of our submissions require you to provide your unique Discord ID - this is a 16 to 19 digit number that uniquely identifies your Discord account. If this is incorrect, we are unable to accept a submission. If you need help finding yours, please refer to https://dis.gd/findid
3. Concerning Responses: If your responses to any of the form questions raise red flags, we decline your submission. Remember that you want to paint yourself in the best light here.
We encourage you to take the time to consider these common points of failure, and would welcome a resubmission from you at any time.
If you have any questions, please reach out in our Discord community: https://chat.nhcarrigan.com
```
### 2.6. Volunteer Application Rejection Template
```md
Dear [Applicant’s Name],
Thank you so much for taking the time to apply for a volunteer role with NHCarrigan. We truly appreciate your interest in contributing your time and energy to our community.
After carefully reviewing your application, we’ve decided not to move forward with your candidacy for this volunteer position. Please don’t take this as a reflection of your value or potential—our selection process is highly competitive, and we often have to make very difficult decisions.
We still encourage you to stay engaged with our community spaces, events, and projects. There are always opportunities to connect, learn, and grow together, and we would love to see you continue to participate.
Thank you again for your interest and enthusiasm. We wish you the very best in all your endeavors and hope our paths cross again in the future.
Warm regards,
Naomi Carrigan
CEO, NHCarrigan
```
### 2.7. Meeting Request Confirmation Template
```md
Hey <name>,
Thank you for reaching out to schedule a meeting! I am excited to connect with you and get to know who you are.
You may use this link to schedule a slot on my calendar: https://zcal.co/nhcarrigan/meet
It looks like we share the <CYC|fCC|both|neither> communities, so you may choose that as your meeting location if you wish.
OR
It does not look like we share any Discord communities, so you will need to select NHCarrigan Discord as your meeting location.
Please note that if you choose to meet in the NHCarrigan Discord, you will need to join our Discord community at https://chat.nhcarrigan.com in order to meet with us. When it is time for your scheduled meeting, you will need to join the "waiting-room" voice channel. We will drag you into our private voice chat when we are ready to chat with you.
If you have any questions, please do not hesitate to reach out to us.
```
### 2.8. Mentorship Programme Welcome Template
```md
Hey <name>,
Welcome to our mentorship programme! We are excited to support you and watch you learn and grow!
In order to participate, you will need to join our Discord community at https://chat.nhcarrigan.com - then, select the mentorship role from our self-selectable roles to gain access to the programme channels.
You will receive further instructions once you have selected the role.
Keep an eye on the Discord community for announcements and opportunities to collaborate!
Congratulations again!
```
### 2.9. Discord Bot Donation Copy Template
These go in the bot SKUs:
### Subscription Name
```
Sponsor Naomi
```
### Subscription Description
```
**How Your Support Makes a Difference**
1. Creating Free Software
- Develop open-source tools accessible to everyone
- Design Discord bots for community management and safe spaces
- Create learning resources and accessibility-focused web applications
2. Building Inclusive Communities
- Manage welcoming online spaces where diverse voices are celebrated
- Organise virtual events, workshops, and mentorship programmes
- Implement inclusive community guidelines
3. Guiding Others in Tech
- Provide mentorship to aspiring technologists from underrepresented groups
- Create educational content (tutorials, blog posts, videos)
- Offer career advice and emotional support
4. Your Contribution's Ripple Effect:
- Challenges the status quo of the tech industry
- Creates opportunities for underrepresented individuals in STEM
- Fosters innovation through diverse perspectives
- Builds a tech community that reflects and serves all of society
Every donation, regardless of size, contributes to this mission. Together, we're creating a more inclusive, accessible, and diverse future for technology.
Thank you for considering a donation and being part of this important journey.
```
### Benefit Name
```
Your donation:
```
### Benefit Description
```
Helps a transfemme technology witch create free software, build inclusive communities, and guide others on their journey in tech.
```
### Notes
- Use my avatar for subscription
- Use pentatrans for benefit
### 2.10. Discord Server Introduction Template
```md
Hello~! I'm Naomi, a 34 year old transfem software engineer and community manager based in Washington. All of my work (and therefore most of my life) is spent online, so I'm always looking for new spaces and people to vibe with. Remote work can feel dreadfully isolating, and this is my attempt to combat that feeling.
<insert bit about community here>
```
### 2.11. Guild Wars 2 Recruitment Advertisement Template
This has to be sent in two chat messages because of the length.
```
Hiya friends~! Naomi's Newbies is a new guild that is really focused on helping newer players come to love the game, and supporting casual players who have busy schedules.
```
```
We have no activity requirement, no rep requirement, a Discord community, and more! If you are interested, please whisper me and I will gladly invite you!
```
### 2.12. Form Consent for Email Communications
Description:
```
At NHCarrigan, we are fully committed to respecting and protecting your privacy. We strictly adhere to a policy of non-disclosure regarding your personal data; we do not sell, trade, or transfer your information to outside parties. The contact details you provide will be used exclusively for the purpose of responding to your inquiry or addressing the subject of this form. For a complete overview of our data practices, please review our [Privacy Policy](https://docs.nhcarrigan.com/legal/privacy/).
```
Question:
```
I agree to be contacted via email, solely for the purpose of addressing this submission.
```
### 2.13. Form Image Header
```html
<div style="width: 100%; text-align: center"><img src="https://cdn.nhcarrigan.com/logo.png" style="width: 250px; height: 250px"></div>
```
### 2.14. Form Confirmation
Add this at the end of any form specific text.
```
If you'd like to stay up to date on everything we do, come hang out in our server! https://chat.nhcarrigan.com
```
### 2.15. Sanction Appeal Denial Email Template
Subject Line: `Appeal Decision - [Sanction Type] Appeal Dismissed`
```md
Dear [Appellant's Name],
Thank you for submitting your appeal regarding the disciplinary sanction imposed on [date of original sanction]. We acknowledge receipt of your appeal and have conducted a thorough review in accordance with our Community Disciplinary Appeals Policy.
After careful consideration by the Appeals Panel, which included examination of all evidence and documentation, review of the original decision and its rationale, and assessment of your submissions and arguments, we have determined that your appeal does not meet the grounds for appeal as established in our policy.
**Decision**: Your appeal has been dismissed. The original disciplinary sanction remains in full effect.
**Reasoning**: [Insert detailed reasoning here, addressing the specific grounds raised in the appeal and explaining why the original decision was appropriate. This should reference procedural compliance, proportionality of the sanction, factual accuracy, evidence considered, and correct application of community policies.]
As outlined in Section 8.1 of our Community Disciplinary Appeals Policy, decisions of the Appeals Panel are final and binding. No further appeals or reviews are available through our internal processes.
We understand that this decision may be disappointing. Our appeals process is designed to ensure fairness and transparency, and we have given your submission careful consideration. The original sanction was imposed in accordance with our community standards and policies, which are designed to maintain a safe and welcoming environment for all members.
If you have any questions about this decision, please note that our Appeals Panel's determination is final. We appreciate your understanding and respect for our community standards and processes.
Regards,
The Appeals Panel
NHCarrigan Community Leadership
```
### 3.1. Reference to Comprehensive Liability Framework
**IMPORTANT: Comprehensive liability limitations, damage exclusions, and maximum liability caps are set forth in our Limitation of Liability and Indemnification Policy, which is incorporated herein by reference.**
### 3.2. Template Usage Disclaimer
These templates are provided for informational purposes only. Our organisation:
- Does not provide legal advice or guarantee the legal effectiveness of these templates
- Does not warrant that these templates will meet specific legal, regulatory, or contextual requirements
- Recommends that users consult with qualified legal counsel when using these templates for legal matters
- Assumes no responsibility for outcomes resulting from the use of these templates
### 3.3. Customisation Requirements
Users are responsible for:
- Customising templates to meet their specific needs and requirements
- Ensuring compliance with applicable laws, regulations, and organisational policies
- Verifying the accuracy and appropriateness of template content for their specific use case
- Obtaining appropriate legal review when necessary
## 4. CONCLUSION
This Templates Documentation provides standardised templates and forms for use throughout our organisation. All users are responsible for ensuring that their use of these templates complies with applicable laws, regulations, and organisational requirements.
---
*For questions about template usage or to suggest improvements, please contact appropriate organisational leadership through designated communication channels.*
src/content/docs/projects/a4p-bot.md
+1 -1
View File
@@ -165,7 +165,7 @@ Your Discord bot requires the following Gateway Intents:
Create a `.env` file in the project root with the following variables:
```sh
```env
# Discord Bot Configuration
TOKEN=your_discord_bot_token
src/content/docs/projects/altaria.md
+1 -1
View File
@@ -14,7 +14,7 @@ Altaria is a friendly Discord bot designed to encourage the use of alt-text (alt
### How to Add Altaria to Your Server
1. Use the official invitation link: [Add to Discord](https://discord.com/oauth2/authorize?client_id=1405356559214837860)
1. Use the official invitation link: [Add to Discord](https://discord.com/oauth2/authorise?client_id=1405356559214837860)
2. Select your server from the dropdown menu
3. Grant the necessary permissions:
- Read Messages/View Channels
src/content/docs/projects/aria-iuvo.md
+1 -1
View File
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
To use Aria Iuvo, [add the bot to your Discord account](https://discord.com/oauth2/authorize?client_id=1338596130207957035) using the provided authorisation link. The bot operates as a user-installable application, meaning it can be used across any Discord server or direct message where you have access.
To use Aria Iuvo, [add the bot to your Discord account](https://discord.com/oauth2/authorise?client_id=1338596130207957035) using the provided authorisation link. The bot operates as a user-installable application, meaning it can be used across any Discord server or direct message where you have access.
### Core Features
src/content/docs/projects/becca-lyria.md
+1 -1
View File
@@ -14,7 +14,7 @@ Becca Lyria is a user-installable Discord bot that transforms your DMs into an i
### Getting Started
1. **Installation**: [Add Becca Lyria to your Discord account](https://discord.com/oauth2/authorize?client_id=1343341112437248041)
1. **Installation**: [Add Becca Lyria to your Discord account](https://discord.com/oauth2/authorise?client_id=1343341112437248041)
2. **Subscription**: The bot requires an active subscription to use its features
3. **Start Playing**: Use the `/start` command to begin your adventure
src/content/docs/projects/boost-monitor.md
+1 -1
View File
@@ -64,7 +64,7 @@ This section is for those interested in running their own instance of the Applic
```
4. Edit `.env` with your configuration:
```sh
```env
DISCORD_TOKEN="your-discord-bot-token"
SENTRY_DSN="your-sentry-dsn"
DEBUG_HOOK="your-discord-webhook-url"
src/content/docs/projects/caelia.md
+3 -3
View File
@@ -10,11 +10,11 @@ This section is for those interacting with a live instance of the Application.
### What is Caelia?
Caelia is a Discord bot designed to help create more inclusive communities by gently notifying users when they may have used language that could be considered non-inclusive. The bot uses the Alex.js library to analyse messages and provide helpful suggestions for more inclusive alternatives.
Caelia is a Discord bot designed to help create more inclusive communities by gently notifying users when they may have used language that could be considered non-inclusive. The bot uses the Alex.js library to analyze messages and provide helpful suggestions for more inclusive alternatives.
### How to Add Caelia to Your Server
1. Visit the authorisation link: https://discord.com/oauth2/authorize?client_id=1408530011572535346
1. Visit the authorisation link: https://discord.com/oauth2/authorise?client_id=1408530011572535346
2. Select your server and grant the necessary permissions
3. Caelia will automatically begin monitoring messages in channels where she has access
@@ -199,7 +199,7 @@ src/
- **Language Rules**: Enhancing Alex.js configuration for better accuracy
- **Error Handling**: Improving error recovery and user experience
- **Performance**: Optimising message processing speed
- **Performance**: Optimizing message processing speed
- **Features**: Adding new functionality while maintaining simplicity
- **Documentation**: Improving user and developer documentation
src/content/docs/projects/callista.md
+2 -2
View File
@@ -11,7 +11,7 @@ This section is for those interacting with a live instance of the Application.
### 1.1. Adding the Bot
Callista is available as a Discord user-installable application. You can add Callista to your Discord account by visiting:
https://discord.com/oauth2/authorize?client_id=1391494389477412906
https://discord.com/oauth2/authorise?client_id=1391494389477412906
### 1.2. Bookmarking Messages
@@ -363,7 +363,7 @@ For questions or support:
### 4.10. Issue Reporting
Please report bugs in the [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) category and feature requests in the [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) category on our support forum.
Please report bugs in the #bug-reports forum channel and feature requests in the #feature-requests forum channel on our Discord community.
Include:
- Clear description of the issue or feature
src/content/docs/projects/chibika.md
+1 -1
View File
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
1. **Add Chibika to Your Discord Server**: Use the [Discord OAuth2 authorisation link](https://discord.com/oauth2/authorize?client_id=1396225647269122098) to add Chibika to your Discord server.
1. **Add Chibika to Your Discord Server**: Use the [Discord OAuth2 authorisation link](https://discord.com/oauth2/authorise?client_id=1396225647269122098) to add Chibika to your Discord server.
2. **Purchase Server Subscription**: To use Chibika's features, you must purchase a server subscription through Discord's built-in store system.
src/content/docs/projects/chronara.md
-40
View File
@@ -1,40 +0,0 @@
---
title: Chronara
---
Chronara (hereinafter the "Application") is an initialized project repository that is currently in scaffold state.
## 1. User Documentation
There is no published live application endpoint documented in the repository at this time.
The current repository content indicates project setup and governance files without user-facing runtime features.
## 2. Technical Documentation
Chronara currently reflects a baseline template repository state.
At present:
1. No runtime source code directories are defined.
2. No build or package manifest files are published.
3. No deployment or execution workflow is documented.
Technical documentation should be expanded once implementation code is introduced.
## 3. Legal Documentation
Project policy files reference global documentation:
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
Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct.
Feedback and bug reports are handled via https://support.nhcarrigan.com.
src/content/docs/projects/cordelia-taryne.md
+9 -9
View File
@@ -2,7 +2,7 @@
title: Cordelia Taryne
---
Cordelia Taryne (hereinafter the "Application") is an AI-powered multi-purpose assistant Discord bot that leverages Anthropic's Claude AI to provide various text processing, analysis, and assistance features. The bot features a distinctive vampire personality named Cordelia with haughty and self-inflated characteristics, providing users with intelligent assistance whilst maintaining a unique character persona.
Cordelia Taryne (hereinafter the "Application") is an AI-powered multi-purpose assistant Discord bot that leverages Anthropic's Claude AI to provide various text processing, analysis, and assistance features. The bot features a distinctive vampire personality named Cordelia with haughty and self-inflated characteristics, providing users with intelligent assistance while maintaining a unique character persona.
## 1. User Documentation
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
To use Cordelia Taryne, [add her to your Discord account](https://discord.com/oauth2/authorize?client_id=1338664192714211459).
To use Cordelia Taryne, [add her to your Discord account](https://discord.com/oauth2/authorise?client_id=1338664192714211459).
### Available Commands
@@ -42,8 +42,8 @@ Cordelia Taryne offers the following slash commands:
- **Access**: Requires active subscription
#### `/mood`
- **Description**: Analyse the sentiment and mood of text passages
- **Parameters**: `text` (required, max 2000 characters) - The text to analyse
- **Description**: Analyze the sentiment and mood of text passages
- **Parameters**: `text` (required, max 2000 characters) - The text to analyze
- **Usage**: `/mood text: I had an amazing day at the beach!`
- **Access**: Requires active subscription
@@ -71,13 +71,13 @@ Most features require an active subscription. The bot uses Discord's premium sub
Cordelia has a distinctive personality:
- **Character**: A vampire assistant with a haughty and self-inflated demeanour
- **Appearance**: Blonde hair in twin buns, pink-red cat-like eyes, pale skin, gold dress
- **Behaviour**: Subtly condescending but never directly rude or insulting
- **Behavior**: Subtly condescending but never directly rude or insulting
- **Communication**: Professional assistance without role-playing text
### Support and Feedback
- **Bug Reports**: Post in the [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) category on our support forum
- **Feature Requests**: Post in the [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) category on our support forum
- **Bug Reports**: Post in the #bug-reports forum channel on our Discord community
- **Feature Requests**: Post in the #feature-requests forum channel on our Discord community
- **General Support**: Visit the [chat server](https://chat.nhcarrigan.com)
- **Contact**: Email `contact@nhcarrigan.com`
@@ -264,7 +264,7 @@ src/
### Contribution Process
1. **Issue Creation**: Post detailed bug reports or feature requests in the appropriate support forum category ([Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) or [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7))
1. **Issue Creation**: Post detailed bug reports or feature requests in the appropriate Discord forum channel (#bug-reports or #feature-requests)
2. **Discussion**: Discuss approach before starting work
3. **Implementation**: Follow coding standards and patterns
4. **Testing**: Test thoroughly in development environment
@@ -288,7 +288,7 @@ src/
4. Test subscription gating and error handling
5. Update documentation
#### Modifying AI Behaviour
#### Modifying AI Behavior
1. Update personality configuration if needed
2. Modify system prompts in relevant modules
3. Test with various inputs and edge cases
src/content/docs/projects/data-api.md
+1 -1
View File
@@ -647,7 +647,7 @@ When contributing, keep security in mind:
If you need help contributing:
- Post in the [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) or [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) categories on our support forum
- Post in the #bug-reports or #feature-requests forum channels on our Discord community
- Join the [Chat Server](https://chat.nhcarrigan.com)
- Email: `contact@nhcarrigan.com`
src/content/docs/projects/eclaire.md
+18 -16
View File
@@ -10,13 +10,13 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
1. **Initial Setup**: Open the configuration screen and provide your API credentials and language preferences.
1. **Initial Setup**: Navigate to the Configuration page to set up your API credentials and language preferences.
2. **Configuration Options**:
- **Deepgram API Key**: Required for speech-to-text transcription.
- **Translation Service API Key**: Required for text translation. The application includes a built-in demonstration key in source comments with a 10 requests/minute limit.
- **Source Language**: Selected from the source-language allow-list defined in the configuration component.
- **Target Language**: Selected from the language-code mapping list used by the configuration component.
- **Deepgram API Key**: Required for speech-to-text transcription. You must provide your own API key from [Deepgram](https://deepgram.com).
- **Translation Service API Key**: Required for text translation. A demo key is available with a 10 requests/minute rate limit, or you can provide your own key.
- **Source Language**: Select from 12 supported languages (English, German, Dutch, Swedish, Danish, Spanish, French, Portuguese, Italian, Turkish, Norwegian, Indonesian).
- **Target Language**: Select from 60+ supported languages for translation.
3. **Using the Translation Interface**:
- Navigate to the Agent page to begin translation.
@@ -43,9 +43,10 @@ The application automatically enables:
### Limitations
- Requires a modern browser with microphone access.
- Requires a WebSocket connection for real-time transcription.
- Translation demo key usage is rate limited.
- Source language is limited to 12 languages supported by Deepgram
- Translation service demo key has a rate limit of 10 requests/minute
- Requires modern browser with microphone access
- WebSocket connection required for real-time functionality
## 2. Technical Documentation
@@ -69,17 +70,17 @@ This section is for those interested in running their own instance of the Applic
2. Install dependencies:
```bash
pnpm install
npm install
```
3. Start the development server:
```bash
pnpm run dev
npm run dev
```
4. Build for production:
```bash
pnpm run build
npm run build
```
### Technology Stack
@@ -87,7 +88,7 @@ This section is for those interested in running their own instance of the Applic
**Frontend Framework:**
- Angular 19.1.4 with standalone components
- TypeScript 5.7.3
- RxJS 7.8.2 for reactive programming
- RxJS 7.8.1 for reactive programming
- Angular Reactive Forms for configuration management
**External APIs:**
@@ -143,7 +144,8 @@ This section is for those interested in running their own instance of the Applic
#### Routing
- `/` - Home page
- `/` - Redirects to home
- `/home` - Landing page
- `/config` - Configuration page
- `/agent` - Translation interface
@@ -190,9 +192,9 @@ POST request body:
#### Available Scripts
- `pnpm run dev` - Start development server
- `pnpm run lint` - Run ESLint with zero warnings policy
- `pnpm run build` - Build for production
- `npm run dev` - Start development server
- `npm run lint` - Run ESLint with zero warnings policy
- `npm run build` - Build for production
#### Code Quality
src/content/docs/projects/elysium.md
+16 -49
View File
@@ -6,66 +6,33 @@ Elysium (hereinafter the "Application") is an idle RPG in the browser.
## 1. User Documentation
The Application provides an incremental/idler gameplay loop with progression systems including:
:::note
This section is coming soon!
:::
1. Adventurer hiring and resource scaling.
2. Zone exploration and boss encounters.
3. Questing and crafting systems.
4. Prestige, transcendence, and apotheosis reset layers.
5. Character profile, titles, and leaderboard visibility.
The API source includes routes for game state, combat, exploration, crafting, progression resets, leaderboards, and profiles (`apps/api/src/index.ts`).
This project is currently marked as work in progress in the public project feed.
This section is for those interacting with a live instance of the Application.
## 2. Technical Documentation
Elysium is a pnpm monorepo with two primary applications and a shared package.
:::note
This section is coming soon!
:::
Workspace layout:
1. `apps/web`: React + Vite frontend (`@elysium/web`).
2. `apps/api`: Hono-based API service (`@elysium/api`).
3. `packages/types`: shared type definitions (`@elysium/types`).
Current versions in repository manifests:
1. Root package: `0.5.0`.
2. API package: `0.5.0`.
3. Web package: `0.5.0`.
Root commands:
1. `pnpm install`
2. `pnpm dev`
3. `pnpm build`
4. `pnpm test`
API runtime notes:
1. Uses `op run --env-file=./prod.env` for secret injection.
2. Exposes a health endpoint at `GET /health`.
3. Uses Prisma client/database tooling and Hono route modules.
This section is for those interested in running their own instance of the Application.
## 3. Legal Documentation
The Application inherits nhcarrigan's global legal documents:
:::note
This section is coming soon!
:::
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`
This section is for expansions to our legal policies specific to the Application.
## 4. Contributing Documentation
Contribution guidance points to the shared docs portal:
:::note
This section is coming soon!
:::
1. https://docs.nhcarrigan.com/#/contributing
The repository also includes a manual verification checklist in `verify.md` for gameplay flows that are not fully covered by automated tests.
This section is for documentation related to contributing to the Application's codebase.
src/content/docs/projects/ephemere.md
-67
View File
@@ -1,67 +0,0 @@
---
title: Ephemere
---
Ephemere (hereinafter the "Application") is a multi-language utility repository containing operational scripts for TypeScript, Python, and Bash workflows.
## 1. User Documentation
Ephemere is a script collection rather than a hosted end-user application.
It is used to run task-focused automation across multiple domains, including:
1. Crowdin translation workflows.
2. Discord and Discourse operations.
3. Gitea and GitHub maintenance tasks.
4. Music metadata and security reporting utilities.
5. Cohort programme operations in Python and Bash.
Scripts are typically executed through the interactive runner to choose language, category, and script at runtime.
## 2. Technical Documentation
Ephemere is organized by language and purpose:
1. `typescript/src/*` for API and platform scripting utilities.
2. `python/cohort/*` for cohort and Discord operations.
3. `bash/*` for cohort team automation and YubiKey administration.
Environment and dependency setup:
1. Node.js `v24+`, `pnpm`, and Python `3.10+` are required.
2. `uv` is used for Python dependency management.
3. `op` (1Password CLI) is used for secret injection from `prod.env`.
Common commands:
1. `make install` installs TypeScript and Python dependencies.
2. `make run` launches the interactive script runner.
3. `make lint` runs TypeScript and Python linting.
4. `make build` performs TypeScript type checking.
5. `make test` runs available test suites.
When running scripts manually, both TypeScript and Python command examples in the repository rely on `op run --env-file=prod.env` for secure secret resolution.
## 3. Legal Documentation
Project policy files reference global documentation:
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
Contributions are accepted through pull requests in accordance with the repository contribution policy and Code of Conduct.
Before opening a pull request:
1. Run `make install`.
2. Run `make lint`.
3. Run `make build`.
4. Run `make test`.
Feedback and bug reports are handled through `https://support.nhcarrigan.com`.
src/content/docs/projects/gwen-abalise.md
+1 -1
View File
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
To use Gwen Abalise, [add her to your Discord server](https://discord.com/oauth2/authorize?client_id=1343413943447584819).
To use Gwen Abalise, [add her to your Discord server](https://discord.com/oauth2/authorise?client_id=1343413943447584819).
### Commands
src/content/docs/projects/hikari-desktop.md
-65
View File
@@ -1,65 +0,0 @@
---
title: Hikari Desktop
---
Hikari Desktop (hereinafter the "Application") is a desktop companion application featuring Hikari, distributed as installable desktop releases.
## 1. User Documentation
Release builds are published at `https://git.nhcarrigan.com/nhcarrigan/hikari-desktop/releases`.
The application provides an interactive desktop experience with conversation, tooling, and workspace support features through a local app interface.
Common user-facing areas include:
1. Conversation and message workflows.
2. Workspace and project context panels.
3. Notification, quick action, and session management panels.
4. Desktop integrations enabled through the bundled runtime.
## 2. Technical Documentation
Hikari Desktop is implemented with a Svelte frontend and a Rust-backed `Tauri` desktop runtime.
Local development commands:
1. Install dependencies with `pnpm install`.
2. Start frontend dev server with `pnpm dev`.
3. Build frontend assets with `pnpm build`.
4. Launch Tauri workflow with `pnpm tauri`.
Quality and release tooling:
1. `pnpm test`, `pnpm test:backend`, and `pnpm test:all` for frontend/backend validation.
2. `pnpm lint` and `pnpm format:check` for static quality checks.
3. `pnpm build:linux`, `pnpm build:windows`, and `pnpm build:all` for desktop packaging.
Implementation notes:
1. Frontend code is under `src/` with Svelte components, stores, and utility modules.
2. Backend/native integration is under `src-tauri/src/`.
3. Desktop capabilities are defined by `src-tauri` configuration and plugins.
## 3. Legal Documentation
Project policy files reference global documentation:
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
Contributions are accepted through pull requests according to the repository contributing guidelines and Code of Conduct.
Before opening a pull request:
1. Run `pnpm install`.
2. Run `pnpm lint`.
3. Run `pnpm test:all`.
4. Run `pnpm build`.
Feedback and bug reports are handled through `https://support.nhcarrigan.com`.
src/content/docs/projects/keiko.md
+1 -1
View File
@@ -114,7 +114,7 @@ npm install
Create a `prod.env` file in the root directory with the following variables:
```sh
```env
DISCORD_TOKEN=your_discord_bot_token
AI_TOKEN=your_anthropic_api_key
LOG_TOKEN=your_logging_token (optional)
src/content/docs/projects/library.md
-58
View File
@@ -1,58 +0,0 @@
---
title: Library
---
Library (hereinafter the "Application") is Naomi's personal library tracking application for cataloguing and engaging with media collections.
## 1. User Documentation
The live instance is available at `https://library.nhcarrigan.com`.
The application is presented as Naomi's curated collection of media and includes books, games, music, shows, manga, and art.
Core user-facing capabilities include:
1. Browsing library entries by media type.
2. Engaging with content through comments and likes.
3. Submitting suggestions for new additions.
4. Viewing activity and leaderboard-style participation features.
## 2. Technical Documentation
The project is an `Nx` monorepo with a frontend app and a Fastify API.
Runtime and build scripts are managed from the repository root:
1. `pnpm dev` builds and runs the production-style API process with development environment values.
2. `pnpm build` generates Prisma client artifacts and builds all projects.
3. `pnpm test` runs configured test targets across the workspace.
4. `pnpm lint` runs lint targets across the workspace.
Architecture notes:
1. API routes are mounted under `/api` via autoloaded Fastify route modules.
2. The API includes dedicated modules for `books`, `games`, `music`, `shows`, `manga`, `art`, `suggestions`, `comments`, `likes`, `leaderboard`, `activity`, and `users`.
3. Security middleware and plugins include CSRF protection, rate limiting, CORS, helmet, and auth-related plugins.
4. Database access is managed with Prisma.
## 3. Legal Documentation
Project policy files reference global documentation:
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
Contributions are accepted through pull requests according to the repository's contributing guidelines and code of conduct.
Before opening a pull request:
1. Install dependencies with `pnpm install`.
2. Run `pnpm lint`.
3. Run `pnpm test`.
4. Run `pnpm build`.
src/content/docs/projects/liora.md
+3 -3
View File
@@ -12,7 +12,7 @@ This section is for those interacting with a live instance of the Application.
To use Liora in your Discord server, you'll need to:
1. **Add the bot to your server**: Visit the [invite link](https://discord.com/oauth2/authorize?client_id=1391492296222179459)
1. **Add the bot to your server**: Visit the [invite link](https://discord.com/oauth2/authorise?client_id=1391492296222179459)
2. **Subscribe to premium**: A server administrator must purchase a server subscription from the Discord store, unless your server is whitelisted
3. **Enable DMs**: Ensure you have direct messages enabled from server members to receive notifications
@@ -199,7 +199,7 @@ pnpm install
Create a `prod.env` file with the following variables:
```sh
```env
DISCORD_TOKEN=your_discord_bot_token
MONGO_URI=your_mongodb_connection_string
LOG_TOKEN=your_logging_service_token
@@ -614,7 +614,7 @@ Releases are managed by the maintainers. Contributors should focus on feature br
**Additional Resources**:
- **Live Bot**: [Add to Discord](https://discord.com/oauth2/authorize?client_id=1391492296222179459)
- **Live Bot**: [Add to Discord](https://discord.com/oauth2/authorise?client_id=1391492296222179459)
- **Source Code**: [Gitea Repository](https://git.nhcarrigan.com/NHCarrigan/liora)
- **Documentation Hub**: [docs.nhcarrigan.com](https://docs.nhcarrigan.com)
- **Support Server**: [chat.nhcarrigan.com](https://chat.nhcarrigan.com)
src/content/docs/projects/logger.md
+2 -2
View File
@@ -225,11 +225,11 @@ If you encounter bugs or have feature requests:
- Chat Server: [https://chat.nhcarrigan.com](https://chat.nhcarrigan.com)
- Email: contact@nhcarrigan.com
- Repository: [https://git.nhcarrigan.com/nhcarrigan/logger](https://git.nhcarrigan.com/NHCarrigan/logger)
- Issues: Post in the [Bug Reports](https://support.nhcarrigan.com/c/bug-reports/6) or [Feature Requests](https://support.nhcarrigan.com/c/feature-requests/7) categories on our support forum
- Issues: Post in the #bug-reports or #feature-requests forum channels on our Discord community
### Package Information
- **Package Name**: @nhcarrigan/logger
- **Version**: 1.1.1
- **Version**: 1.0.0
- **NPM**: [https://www.npmjs.com/package/@nhcarrigan/logger](https://www.npmjs.com/package/@nhcarrigan/logger)
- **Repository**: Git-based repository hosted at git.nhcarrigan.com
src/content/docs/projects/lore.md
-63
View File
@@ -1,63 +0,0 @@
---
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:
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
Lore is built with Angular and uses a standard Angular CLI workflow.
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
Project policy files reference global documentation:
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
Contributions are accepted through pull requests under the repository's contribution policy and Code of Conduct.
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`.
src/content/docs/projects/lucinda.md
+16 -39
View File
@@ -6,56 +6,33 @@ Lucinda (hereinafter the "Application") is a kanban-style task management site.
## 1. User Documentation
The Application is intended as a full-featured cloud-backed task management platform with a Kanban-style workflow.
:::note
This section is coming soon!
:::
Current public deployment listed by the project repository:
1. https://lucinda.nhcarrigan.com
The frontend currently routes users to a landing experience (`/landing`) and serves as the basis for expanded board/task flows.
This section is for those interacting with a live instance of the Application.
## 2. Technical Documentation
Lucinda is a pnpm workspace monorepo with separate client and server applications.
:::note
This section is coming soon!
:::
Project structure:
1. `client`: Angular 19 frontend.
2. `server`: Fastify API service.
Workspace tooling:
1. Root scripts use Turbo (`turbo run dev|build|lint|test`).
2. Server development command: `tsx src/index.ts --watch`.
3. Server start command: `op run --env-file=./prod.env -- node prod/index.js`.
Current repository version values:
1. Root: `0.0.0`
2. Client: `0.0.0`
3. Server: `0.0.0`
Current server implementation exposes a root health endpoint on port `12346` returning `{"message":"Hello, world!"}`.
This section is for those interested in running their own instance of the Application.
## 3. Legal Documentation
The Application uses the shared nhcarrigan legal documents:
:::note
This section is coming soon!
:::
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`
This section is for expansions to our legal policies specific to the Application.
## 4. Contributing Documentation
Contributing guidance points to the shared docs portal:
:::note
This section is coming soon!
:::
1. https://docs.nhcarrigan.com/#/contributing
Feature delivery is in progress, and the public project feed currently marks Lucinda as work in progress.
This section is for documentation related to contributing to the Application's codebase.
src/content/docs/projects/maribelle.md
+16 -44
View File
@@ -6,61 +6,33 @@ Maribelle (hereinafter the "Application") is a Discord bot that allows you to co
## 1. User Documentation
The Application posts weekday stand-up prompts in configured Discord text channels and tracks which members posted progress updates in the previous cycle.
:::note
This section is coming soon!
:::
Current reminder schedule in the source is `0 9 * * 1-5` (09:00, Monday through Friday).
During operation, the Application:
1. Sends a stand-up reminder message in each configured channel.
2. Starts a thread named `Daily Progress Update - <date>`.
3. Monitors messages in those threads and records participant IDs.
4. Sends a summary of recorded IDs to the maintainer account before the next cycle.
Channel and role mappings are configured in `src/config/channels.ts`.
This section is for those interacting with a live instance of the Application.
## 2. Technical Documentation
The Application is a Node.js + TypeScript Discord bot using `discord.js` and `node-schedule`.
:::note
This section is coming soon!
:::
Runtime and build commands from `package.json`:
1. `pnpm install`
2. `pnpm build`
3. `pnpm start`
The startup command runs with `op run --env-file=prod.env`, so local operation expects a `prod.env` file and 1Password CLI access.
Minimum environment variables for runtime include:
1. `DISCORD_TOKEN` for bot authentication.
2. `LOG_WEBHOOK_URL` for logger transport.
Key implementation files:
1. `src/index.ts` bootstraps the Discord client, schedules reminders, and listens for thread messages.
2. `src/modules/standup.ts` sends reminders, opens threads, and reports participant IDs.
3. `src/config/channels.ts` defines target channel/role pairs.
This section is for those interested in running their own instance of the Application.
## 3. Legal Documentation
The Application inherits the nhcarrigan global legal documents:
:::note
This section is coming soon!
:::
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`
This section is for expansions to our legal policies specific to the Application.
## 4. Contributing Documentation
Contribution guidance for the Application points to the shared documentation:
:::note
This section is coming soon!
:::
1. https://docs.nhcarrigan.com/#/contributing
Project metadata currently reports version `0.0.0` in `package.json`, which aligns with an unreleased/early state.
This section is for documentation related to contributing to the Application's codebase.
src/content/docs/projects/maylin-taryne.md
+1 -1
View File
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Quick Start
1. [Add Maylin to your Discord account](https://discord.com/oauth2/authorize?client_id=1343370633916059668)
1. [Add Maylin to your Discord account](https://discord.com/oauth2/authorise?client_id=1343370633916059668)
2. Use the `/dm` command to start a private conversation
3. Send messages directly to Maylin in DMs for AI-powered companionship
src/content/docs/projects/melody-iuvo.md
+1 -1
View File
@@ -10,7 +10,7 @@ This section is for those interacting with a live instance of the Application.
### Getting Started
To use Melody Iuvo, you'll need to [add the bot to your Discord account](https://discord.com/oauth2/authorize?client_id=1338753576583041074) and subscribe to access the premium features.
To use Melody Iuvo, you'll need to [add the bot to your Discord account](https://discord.com/oauth2/authorise?client_id=1338753576583041074) and subscribe to access the premium features.
### Available Commands
src/content/docs/projects/minori.md
-37
View File
@@ -1,37 +0,0 @@
---
title: Minori
---
Minori (hereinafter the "Application") is
## 1. User Documentation
:::note
This section is coming soon!
:::
This section is for those interacting with a live instance of the Application.
## 2. Technical Documentation
:::note
This section is coming soon!
:::
This section is for those interested in running their own instance of the Application.
## 3. Legal Documentation
:::note
This section is coming soon!
:::
This section is for expansions to our legal policies specific to the Application.
## 4. Contributing Documentation
:::note
This section is coming soon!
:::
This section is for documentation related to contributing to the Application's codebase.
src/content/docs/projects/mommy-bot.md
+2 -2
View File
@@ -7,13 +7,13 @@ Mommy Bot (hereinafter the "Application") is a multi-platform bot application th
## 1. User Documentation
### Discord Usage
- [Install the app](https://discord.com/oauth2/authorize?client_id=1347642447643017289)
- [Install the app](https://discord.com/oauth2/authorise?client_id=1347642447643017289)
- Use the `/mommy` slash command
- Optionally provide a name parameter: `/mommy name:YourName`
- The bot will respond with an encouraging message personalised to your name
### Slack Usage
- [Install the app](https://slack.com/oauth/v2/authorize?client_id=8569765106322.8554301974567&scope=commands&user_scope=)
- [Install the app](https://slack.com/oauth/v2/authorise?client_id=8569765106322.8554301974567&scope=commands&user_scope=)
- Use the `/mommy` command in any channel where the bot is installed
- Optionally provide a name: `/mommy YourName`
- The bot will respond with an encouraging message

Some files were not shown because too many files have changed in this diff Show More