feat: audit all documentation
Code Analysis / SonarQube (push) Failing after 22s
Node.js CI / Lint and Test (push) Failing after 32s

This commit is contained in:
2025-08-25 16:52:48 -07:00
parent f7efaef26e
commit d3560a3066
8 changed files with 1700 additions and 2470 deletions
+20 -70
View File
@@ -56,10 +56,8 @@ ssh-keygen -Y verify -f /path/to/saved/key -I naomi@nhcarrigan.com -n socials -s
We offer FREE support through several PUBLIC channels, including:
- Community Forums
- Public Repository Issues
- Open IRC Channels
- Custom Fediverse Instance
- Discord server
These channels are ideal for:
@@ -88,32 +86,27 @@ Our platforms offer various ways to engage with our projects and community:
- Seek mentorship in software development
- Participate in casual discussions with our team and community members
### 1.4 Platform Directory
Below, you'll find a comprehensive list of our official communication platforms. Each platform serves specific purposes and caters to different types of interactions. Please choose the most appropriate channel for your needs to ensure the fastest and most effective response.
### 1.5 Contact Form
### 1.4 Contact Form
We offer a [contact form](https://forms.nhcarrigan.com/form/HyqoJ9Th5QDiOn_GPLNIRhe1a5ON7mDQf-O_ukM6R4g) for direct, low-priority communication requests.
It is often faster to reach out through one of the above platforms, and best to consider this contact form as a backup in the event of a severe outage.
It is often faster to reach out through one of the below platforms, and best to consider this contact form as a backup in the event of a severe outage.
## 2. Communication Platforms
### 2.1. Forum
### 2.1. Discord
Our self-hosted forum allows for more long-form communication, which is ideal for support queries and in-depth conversations.
Our Discord server allows for both quick and in-depth communication.
- Join Link: https://forum.nhcarrigan.com
- Join Link: https://chat.nhcarrigan.com
- Features:
- Quick response times
- Threaded conversations
- Persistent and indexed posts
- Community powered support
- Best for: Support queries
### 2.2. Code Repositories
Our code repositories are all self-hosted. Sign-ups are open for anyone who wants to file an issue or comment on a discussion, but making code contributions is restricted to our core team.
Our code repositories are all self-hosted. You will need to request an account via our form: https://forms.nhcarrigan.com/form/c0_N5hb-VcmC2ClzaGOvDxVirMN_coiWG7eoPhDPsZ0
- Link: https://git.nhcarrigan.com
- Features:
@@ -134,7 +127,7 @@ Our code repositories are all self-hosted. Sign-ups are open for anyone who want
We have a dedicated forum category where we post all of our organisational updates.
- URL: https://announcements.nhcarrigan.com
- URL: https://hikari.nhcarrigan.com/announcements
- Nature: You can reply to announcement threads to discuss the announcement.
- Content:
- Project updates and new releases
@@ -157,7 +150,7 @@ Our blog contains more personal posts and updates.
### 3.3 Interacting with Announcements
All of our announcements are read-only, but you can discuss them in any of our platforms mentioned in Section 1!
All of our announcements are read-only, but you can discuss them in any of our platforms mentioned in Section 2!
### 3.6 Historical Announcements
@@ -183,25 +176,7 @@ LinkedIn serves as our primary professional networking platform.
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 Peerlist Profile
As an alternative to LinkedIn, we maintain a presence on Peerlist, a platform focused on tech professionals.
- Profile URL: https://peerlist.io/naomi_lgbt
- Purpose:
- Showcase technical projects and contributions
- Highlight specific skills and technologies
- Connect with other tech professionals
- Best for:
- Tech-focused recruiters and companies
- Fellow developers and engineers
- Open-source collaborators
#### 4.2.1 Engaging on Peerlist
Feel free to explore our projects and contributions on Peerlist. You can leave comments or questions on specific items in our portfolio.
### 4.3 Professional Inquiries
### 4.2 Professional Inquiries
When reaching out for professional reasons, please consider the following:
@@ -209,15 +184,15 @@ When reaching out for professional reasons, please consider the following:
- Relevant Background: Provide brief context about yourself or your company.
- Specific Questions: If you have particular queries, include them in your initial message.
### 4.4 Services
### 4.3 Services
If you're interested in hiring us to perform some work for you, fill out the form at https://forms.nhcarrigan.com/form/XRlQjeu8CbMrTA-v0IPOxlUPEPitLKXTWg70UUCIORA.
### 4.5 Speaking Engagements and Events
### 4.4 Speaking Engagements and Events
If you're interested in having us speak at your event or contribute to your publication, fill out the form at https://forms.nhcarrigan.com/form/Xqap3Q8hazzJd4Rrp9OOs9ip8Pa7C9zOVThlyFoPCbU.
### 4.6 Keeping Professional Connections Updated
### 4.5 Keeping Professional Connections Updated
We regularly update our professional profiles with new projects, skills, and achievements. Follow us on these platforms to stay informed about our professional journey and potential opportunities for collaboration.
@@ -271,8 +246,6 @@ An in-depth, personalized session focused on long-term professional growth and s
- Complete the [meeting request form](https://forms.nhcarrigan.com/form/uUKZiJSDm6847iDOlpZkD5QF7cAjoTbTm0F4T0EdW0I)
- Wait for an email to schedule a time
- Once a time is agreed upon, you will receive an invoice via email.
- The invoice MUST be paid at least 24 hours prior to your session.
### 5.5 Preparing for Your Session:
@@ -282,18 +255,13 @@ An in-depth, personalized session focused on long-term professional growth and s
### 5.6 Additional Information:
- All sessions are conducted virtually via a video call over Zoom or Google Meet.
- Payment is required at the time of booking
- All sessions are conducted virtually via a video call in our Discord server.
- Rescheduling is possible with at least 24 hours notice
For any questions about these sessions or to discuss a different type of engagement, please reach out through our preferred contact methods listed in previous sections.
## 6. Email Communication
:::caution
Email communication is considered a paid service and will be invoiced at $25 per email we receive.
:::
We offer several email addresses for specific types of inquiries. Please use the appropriate email address to ensure your message reaches the right team and receives the most efficient response.
### 6.1 General Inquiries
@@ -445,16 +413,9 @@ By communicating with us via email, you agree to adhere to these guidelines and
## 7. Direct Messages
:::caution
Direct messages (DMs) are considered a paid service and will be invoiced at $25 per message we receive.
:::
### 7.1 Direct Message Policy
We offer direct messaging as a premium, personalized communication channel. However, to manage our time effectively and ensure the highest quality of service, we have implemented the following policy for direct messages:
- Each direct message received will be invoiced at $25.
- This applies to all platforms where direct messaging is available.
We offer direct messaging as a private, personalized communication channel. However, to manage our time effectively and ensure the highest quality of service, direct messages are the lowest priority of communication. Instead, we strongly encourage you to reach out via our Discord community.
### 7.2 Purpose and Use
@@ -464,28 +425,17 @@ Direct messages should be used for:
- Sensitive information that shouldn't be shared publicly
- Personalized support or consultation requests
### 7.3 Invoicing and Payment
- An invoice will be generated for each direct message received.
- Payment is required before a response will be provided.
- Invoices will be sent to you via the direct message channel on the platform where the direct message was received.
### 7.4 Response Time
- Once payment is received, we aim to respond to direct messages within 1-2 business days.
- We aim to respond to direct messages within 5-7 business days.
- Complex inquiries may require additional time, which will be communicated to you.
### 7.5 Refund Policy
- Due to the immediate nature of the service, refunds for direct messages are not typically offered.
- In exceptional circumstances, refund requests will be considered on a case-by-case basis.
### 7.6 Appropriate Use
### 7.5 Appropriate Use
- Direct messages should be used responsibly and for legitimate purposes only.
- Abusive, harassing, or spam messages will not be tolerated and may result in blocking or reporting to the platform.
### 7.7 Alternatives
### 7.6 Alternatives
We encourage users to consider the following alternatives before sending a direct message:
@@ -495,6 +445,6 @@ We encourage users to consider the following alternatives before sending a direc
### 7.8 Consent and Acknowledgment
By sending a direct message, you acknowledge that you have read and agreed to this policy, including the fee structure and invoicing process.
By sending a direct message, you acknowledge that you have read and agreed to this policy.
Remember, while we value direct communication, we encourage the use of our public channels whenever possible to foster community engagement and shared learning.
+1 -3
View File
@@ -52,6 +52,4 @@ For any questions about donations or to discuss other support options, please co
## 6. Perks
Once you have donated, make sure to join our [forum](https://forum.nhcarrigan.com)! Once there, DM Naomi to request access to our special supporters subforum!
You can also get a special role and private channel in our [Discord](https://chat.nhcarrigan.com)!
Once you have donated, make sure to join our [Discord](https://chat.nhcarrigan.com)! Once there, ping Naomi to request access to our special supporters channel and role!
+1 -5
View File
@@ -4,7 +4,7 @@ title: Hire us!
We're excited about the opportunity to collaborate with you and contribute to the success of your goals. Our team brings a wealth of experience and a passion for delivering high-quality solutions tailored to your specific needs.
!["If you knew I was so unstable, why'd you hire me?](https://cdn.nhcarrigan.com/hire.jpeg)
!["If you knew I was so unstable, why'd you hire me?"](https://cdn.nhcarrigan.com/hire.jpeg)
## 1. Our Services
@@ -35,10 +35,6 @@ For more complex, long-term, or in-depth projects, we recommend booking an in-de
### 2.3. Mentorship Session (60 minutes)
:::tip
Individual mentorship sessions are made available for those who might need one-off guidance, but the best value is actually through our [Mentorship programme](/about/mentorship).
:::
For those seeking personalized guidance and skill development, we offer a full mentorship session.
- Ideal for: Individuals looking to enhance their skills in development, community management, or related areas
+11 -19
View File
@@ -16,23 +16,19 @@ To enrol in the Programme, [fill out the application](https://forms.nhcarrigan.c
Upon successful enrolment, the Mentee receives the following benefits:
### 2.1 Monthly 1:1 Sessions
### 2.1 Dedicated Discord Channels
Participants are entitled to one monthly 1:1 session with a mentor to discuss progress, set goals, and address any questions. Scheduling of these sessions is subject to mutual agreement and the mentors availability.
### 2.2 Private Discord Channel
Participants will have access to a private Discord channel exclusively for Mentees. This channel offers priority response times from the NHCarrigan team. All participants must adhere to the Discord Code of Conduct found [here](https://docs.nhcarrigan.com).
Participants will have access to private Discord channels exclusively for Mentees. These channels get priority response times from the NHCarrigan team. All participants must adhere to our [Code of Conduct](https://docs.nhcarrigan.com/community/coc/).
### 2.3 Group Meetings
If the Programme enrols five (5) or more participants within a given month, all Mentees will be invited to a monthly group meeting. This meeting will provide opportunities for group discussions, shared experiences, and networking.
If the Programme enrols five (5) or more participants within a given month, all Mentees will be invited to a weekly monthly group meeting. This meeting will provide opportunities for group discussions, shared experiences, and networking.
### 2.4 Maintainer-Level Access to Open Source Projects
### 2.4 Flagship Project
Participants will gain maintainer-level access to NHCarrigans open-source projects for hands-on work experience. This access is a privilege and requires adherence to project guidelines, which can be reviewed [here](https://docs.nhcarrigan.com).
Participants will gain maintainer-level access to a repository under our [Mentorship GitHub organisation](https://github.com/nhcarrigan-mentorship), which they will use to build their flagship project under the tutelage of our team.
### 2.5 Internship and Resume Building
### 2.5 Career Prep and Resume Building
Participants will have the opportunity to build their resumes through an internship with NHCarrigan. This includes eligibility for project contributions and collaboration with the NHCarrigan team.
@@ -40,22 +36,18 @@ Participants will have the opportunity to build their resumes through an interns
Mentees will receive continuous resume reviews, personalized learning roadmaps, and dedicated guidance for the duration of their membership. Additional resources and Programme updates will be provided as part of this lifetime membership support.
## 3. Payment Terms
The Programme fee of $200 USD is due at the start of each month to retain membership. Failure to make payments may result in suspension or termination of services.
## 4. Code of Conduct
## 3. Code of Conduct
Participants agree to uphold the Companys Code of Conduct and other policies, as outlined in the [NHCarrigan Documentation](https://docs.nhcarrigan.com/commnuity/coc.md).
## 5. Programme Modifications
## 4 Programme Modifications
NHCarrigan reserves the right to modify Programme features, benefits, and terms at any time. Notification of such changes will be provided to participants with as much advance notice as possible.
## 6. Termination and Cancellation
## 5. Termination and Cancellation
Participants may cancel their membership at any time, effective at the end of the current billing cycle. Refunds will not be issued for partial months. NHCarrigan reserves the right to terminate membership if a participant violates any of these Terms.
Participants may cancel their membership at any time, by providing written notice to our team indicating their desire to drop-out and the reason for leaving..
## 7. Contact Information
## 6. Contact Information
For questions or further information, please contact the NHCarrigan team through the official support channels listed in the [documentation](https://docs.nhcarrigan.com/about/contact).
+1 -1
View File
@@ -2,7 +2,7 @@
title: Mission Statement
---
This Mission Statement ("Statement") articulates the core values and guiding principles of [Company Name] in its efforts to build inclusive, ethical, and sustainable technology solutions.
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.
## 1. Core Values
+1 -1
View File
@@ -20,7 +20,7 @@ Prior to submitting an appeal, please ensure you have the following information
4. A clear and concise explanation of why you believe the moderation decision was erroneous or disproportionate.
5. A statement detailing your motivations for seeking reinstatement and the potential positive contributions you intend to make to our community.
Please note that incomplete or inadequately prepared appeals may be summarily dismissed. You can [find your sanction in our logs](https://moderation.nhcarrigan.com) to review.
Please note that incomplete or inadequately prepared appeals may be summarily dismissed. You can [find your sanction](https://hikari.nhcarrigan.com/sanctions) to review.
## 2. Appeal Submission Process
File diff suppressed because it is too large Load Diff
+3 -3
View File
@@ -12,10 +12,9 @@ These entities directly store, manage, or handle our application data.
| Entity | Data Processed |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Anthropic | Messages/commands sent to and from any of our applications that use an AI integration. |
| DigitalOcean | Any data transmitted over the network to and from our applications. |
| HubSpot | Data submitted to our Contact, Sales Inquiry, Sanction Appeals, Newsletter Sign-up, and Staff Application forms, as well as data transmitted via our embedded chat widgets. |
| MongoDB | Any data provided to our applications when you interact with them. |
| ProtonMail | Any information transmitted to and from our `nhcarrigan.com` email addresses. |
| Stripe | Information provided during the identity and age verification processes necessary to access certain applications and community channels, and payment information for invoices. |
### 1.2. Secondary Subprocessors
@@ -24,6 +23,7 @@ In addition to our primary subprocessors, platforms and services you engage with
Such platforms include, but are not limited to:
- Codeberg
- Discord
- GitHub
- Paypal
- Twitch