nhcarrigan/docs
2
0
Fork 0
generated from nhcarrigan/template
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: last wave of tweaks

Browse Source
This commit is contained in:
Naomi Carrigan 2025-01-22 21:19:03 -08:00
parent a7d906e150
commit 7e3a9f64ac
Signed by: naomi
SSH Key Fingerprint: SHA256:rca1iUI2OhAM6n4FIUaFcZcicmri0jgocqKiTTAfrt8
10 changed files with 53 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
astro.config.mjs
View File

@ -21,9 +21,8 @@ export default defineConfig({
},
lastUpdated: true,
social: {
codeberg: "https://codeberg.org/nhcarrigan",
github: "https://github.com/nhcarrigan",
discord: "https://chat.nhcarrigan.com"
codeberg: "https://git.nhcarrigan.com",
discourse: "https://forum.nhcarrigan.com"
},
head: [
{

10
src/content/docs/about/hire.md
View File

@ -25,8 +25,6 @@ For those with a well-defined product idea or seeking a quick review of their co
- Duration: 15 minutes
- Outcome: Rapid insights and direction for your project
Book via [Topmate](https://topmate.io/nhcarrigan/913917), [Gumroad](https://nhcarrigan.gumroad.com/l/chat), [Fiverr](https://www.fiverr.com/nhcarrigan/schedule-a-30-minute-one-on-one-with-you-to-discuss-your-consulting-needs), [Patreon](https://www.patreon.com/nhcarrigan/shop/quick-sync-622924), [Ko-fi](https://ko-fi.com/s/8ff29882b1), or directly through [Discord](https://discord.com/channels/1146133490933436476/shop/1303095252995014767).
### 2.2. In-Depth Consultation (30 minutes)
For more complex, long-term, or in-depth projects, we recommend booking an in-depth consultation.
@ -35,8 +33,6 @@ For more complex, long-term, or in-depth projects, we recommend booking an in-de
- Duration: 30 minutes
- Outcome: Comprehensive project assessment and tailored recommendations
Book via [Topmate](https://topmate.io/nhcarrigan/913920), [Gumroad](https://nhcarrigan.gumroad.com/l/consulting), [Fiverr](https://www.fiverr.com/nhcarrigan/schedule-a-30-minute-one-on-one-with-you-to-discuss-your-consulting-needs), [Patreon](https://www.patreon.com/nhcarrigan/shop/consulting-session-622928), [Ko-fi](https://ko-fi.com/s/542dedd6e4), or directly through [Discord](https://discord.com/channels/1146133490933436476/shop/1235463041613824040).
### 2.3. Mentorship Session (60 minutes)
:::tip
@ -49,8 +45,6 @@ For those seeking personalized guidance and skill development, we offer a full m
- Duration: 60 minutes
- Outcome: Personalized learning path, hands-on projects, and ongoing support
Book via [Topmate](https://topmate.io/nhcarrigan/913921), [Gumroad](https://nhcarrigan.gumroad.com/l/mentorship), [Fiverr](https://www.fiverr.com/nhcarrigan/schedule-a-30-minute-one-on-one-with-you-to-discuss-your-consulting-needs), [Patreon](https://www.patreon.com/nhcarrigan/shop/mentorship-session-622930), [Ko-fi](https://ko-fi.com/s/4c6c4d3e0d), or directly through [Discord](https://discord.com/channels/1146133490933436476/shop/1303095415935209583)
## 3. Why Choose Us?
- **Expertise**: Years of experience in development and community management
@ -60,8 +54,6 @@ Book via [Topmate](https://topmate.io/nhcarrigan/913921), [Gumroad](https://nhca
## 4. Ready to Get Started?
1. For a quick discussion: [Book a 15-minute sync](https://topmate.io/nhcarrigan/913917)
2. For in-depth consultations: [Schedule a 30-minute slot](https://topmate.io/nhcarrigan/913920)
3. For ongoing mentorship: [Explore our mentorship package](https://topmate.io/nhcarrigan/913932)
Submit a [meeting request](https://forms.nhcarrigan.com/session)!
Not sure which option is right for you? Feel free to contact us with any questions. We're excited to explore how we can help bring your ideas to life and contribute to your success!

2
src/content/docs/community/appeal.md
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://logs.nhcarrigan.com) to review.
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.
## 2. Appeal Submission Process

4
src/content/docs/dev/contributing.md
View File

@ -172,7 +172,7 @@ If you encounter any issues during setup:
2. Search for similar issues in the project's issue tracker.
3. If the problem persists, open a new issue with detailed information about the problem and steps to reproduce it.
You can also reach out to us in our Discord server: https://chat.nhcarrigan.com
You can also reach out to us on our forum: https://forum.nhcarrigan.com
## 4. Claiming an Issue
@ -357,7 +357,7 @@ Before submitting a pull request:
1. Ensure all tests pass.
1. Review your changes and commit history.
If you're unsure about any part of the process or need help, don't hesitate to ask in our [chat server](https://chat.nhcarrigan.com). Our community is here to support you!
If you're unsure about any part of the process or need help, don't hesitate to ask in our [forum](https://forum.nhcarrigan.com). Our community is here to support you!
## 6. Submitting a Pull Request

57
src/content/docs/dev/labels.md
View File

@ -8,7 +8,7 @@ We use very specific labels to help categorise our issues. This page explains wh
These are the most important. These labels indicate who is encouraged to make a pull request to resolve the issue.
### 1.1. `good first issue`
### 1.1. `contribute: good first issue`
#### 1.1.1. Purpose
@ -22,7 +22,7 @@ Does not require prior knowledge of the codebase. Issues with this label should
Contributors are responsible for ensuring their work complies with the project's licensing terms and contribution guidelines.
### 1.2. `help wanted`
### 1.2. `contribute: help wanted`
#### 1.2.1. Purpose
@ -36,7 +36,7 @@ Typically assumes prior experience with the codebase. As such, issues may not in
Contributors should review and adhere to the project's contribution guidelines and code of conduct before submitting work on these issues.
### 1.3. `🔒 staff only`
### 1.3. `contribute: staff only`
#### 1.3.1. Purpose
@ -58,7 +58,7 @@ Labels are assigned based on the project maintainers' best judgment but may not
These labels indicate the scope of the work required to resolve the issue.
### 2.1. `💻 aspect: code`
### 2.1. `aspect: code`
#### 2.1.1. Purpose
@ -72,7 +72,7 @@ Involves direct modification to the project's source code. Familiarity with the
Contributors must ensure their code changes comply with the project's coding standards, license terms, and any applicable software patents or copyrights.
### 2.2. `🤖 aspect: dx`
### 2.2. `aspect: dx`
#### 2.2.1. Purpose
@ -86,7 +86,7 @@ May include changes to automated tests, development dependencies, build processe
Changes to tooling or dependencies must be compatible with the project's overall licensing strategy and not introduce conflicts with existing terms.
### 2.3. `🕹 aspect: interface`
### 2.3. `aspect: interface`
#### 2.3.1. Purpose
@ -100,7 +100,7 @@ May require changes in the code, particularly in front-end components. Can inclu
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.
### 2.4. `📄 aspect: text`
### 2.4. `aspect: text`
#### 2.4.1. Purpose
@ -122,7 +122,7 @@ Aspect labels are assigned based on the primary focus of the issue but may not e
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.
### 3.1. `⭐ goal: addition`
### 3.1. `goal: addition`
#### 3.1.1. Purpose
@ -136,7 +136,7 @@ Typically involves creating new code files. Understanding of how different modul
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.
### 3.2. `🛠 goal: fix`
### 3.2. `goal: fix`
#### 3.2.1. Purpose
@ -150,7 +150,7 @@ Typically involves editing code within existing files. Scope should be kept to t
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).
### 3.3. `✨ goal: improvement`
### 3.3. `goal: improvement`
#### 3.3.1. Purpose
@ -172,7 +172,7 @@ While goal labels provide guidance on the nature of the task, the actual work re
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.
### 4.1. `🟥 priority: critical`
### 4.1. `priority: critical`
#### 4.1.1. Purpose
@ -186,7 +186,7 @@ Require urgent resolution to restore project functionality. Experience with the
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).
### 4.2. `🟧 priority: high`
### 4.2. `priority: high`
#### 4.2.1. Purpose
@ -200,7 +200,7 @@ Not critical for current project operation but blocking future progress. Require
May involve compliance deadlines or contractual obligations that need to be met. Could impact project timelines, potentially affecting agreements with stakeholders or clients.
### 4.3. `🟨 priority: medium`
### 4.3. `priority: medium`
#### 4.3.1. Purpose
@ -214,7 +214,7 @@ Important for project improvement but not critical for current functionality. Sh
May involve improvements to user experience or accessibility, which could have legal implications if neglected long-term. Could relate to optimizations that affect performance guarantees or service level agreements.
### 4.4. `🟩 priority: low`
### 4.4. `priority: low`
#### 4.4.1. Purpose
@ -228,7 +228,7 @@ Desirable improvements or minor issues that don't significantly impact project f
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.
### 4.5. `🟪 priority: none`
### 4.5. `priority: none`
#### 4.5.1. Purpose
@ -250,7 +250,7 @@ Priority labels reflect the project maintainers' current assessment and may be s
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.
### 5.1. `🚦 status: awaiting triage`
### 5.1. `status: awaiting triage`
#### 5.1.1. Purpose
@ -264,7 +264,7 @@ Should be applied to issues when they are opened.
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.
### 5.2. `🚧 status: blocked`
### 5.2. `status: blocked`
#### 5.2.1. Purpose
@ -273,11 +273,12 @@ Indicates issues with a planned resolution that depend on the completion of anot
#### 5.2.2. Characteristics
Not yet ready for work but expected to be addressed in the future.
#### 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.
### 5.3. `⛔️ status: discarded`
### 5.3. `status: discarded`
#### 5.3.1. Purpose
@ -291,7 +292,7 @@ Typically applied to feature requests that don't align with project goals.
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.
### 5.4. `🙅 status: discontinued`
### 5.4. `status: discontinued`
#### 5.4.1. Purpose
@ -305,7 +306,7 @@ Indicates no new features will be added, but bug fixes and support continue.
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.
### 5.5. `🏷 status: label work required`
### 5.5. `status: label work required`
#### 5.5.1. Purpose
@ -319,7 +320,7 @@ May have ongoing discussions but lack appropriate classification.
Proper labeling is crucial for efficient project management and may have implications for compliance tracking and reporting. Establish clear guidelines for labeling to ensure consistency and avoid potential misunderstandings.
### 5.6. `🏁 status: ready for dev`
### 5.6. `status: ready for dev`
#### 5.6.1. Purpose
@ -333,7 +334,7 @@ May have an assigned contributor who has expressed interest.
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.
### 5.7. `🧹 status: ticket work required`
### 5.7. `status: ticket work required`
#### 5.7.1. Purpose
@ -355,7 +356,7 @@ Status labels reflect the current assessment of the project team and may change
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.
### 6.1. `💬 talk: discussion`
### 6.1. `talk: discussion`
#### 6.1.1. Purpose
@ -369,7 +370,7 @@ Ongoing dialogue between maintainers, contributors, and/or users. May involve de
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.
### 6.2. `❓ talk: question`
### 6.2. `talk: question`
#### 6.2.1. Purpose
@ -391,7 +392,7 @@ Conversation labels indicate ongoing dialogue and do not guarantee that an issue
Pull Request (PR) labels are used to indicate the current status of pull requests and guide contributors through the review and merge process.
### 7.1. `⚠️ pull: merge conflict`
### 7.1. `pull: merge conflict`
#### 7.1.1. Purpose
@ -405,7 +406,7 @@ Conflicts need to be resolved before the PR can be reviewed or merged. May requi
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).
### 7.2. `🔍 pull: ready for review`
### 7.2. `pull: ready for review`
#### 7.2.1. Purpose
@ -419,7 +420,7 @@ PR has been submitted as complete and ready for evaluation. Maintainers should p
Ensure contributors understand that "ready for review" doesn't guarantee acceptance or merging. Maintain clear review criteria and communicate them to contributors.
### 7.3. `⏫ pull: requires update`
### 7.3. `pull: requires update`
#### 7.3.1. Purpose
@ -439,7 +440,7 @@ The presence of these labels does not guarantee that a pull request will be merg
## 8. Continuous Improvement
We encourage all project participants to provide feedback on our labeling system. If you have suggestions for improvements or notice any inconsistencies, please reach out to us in our [chat server](https://chat.nhcarrigan.com).
We encourage all project participants to provide feedback on our labeling system. If you have suggestions for improvements or notice any inconsistencies, please reach out to us in our [forums](https://forum.nhcarrigan.com).
## 9. Legal Notice

6
src/content/docs/legal/license.md
View File

@ -164,7 +164,7 @@ If You distribute or make available Our Software to others, You are responsible
#### 2.1.4. Reporting Harmful Usage
If You become aware of any use of Our Software that violates this "Do No Harm" principle, You are encouraged to report it to Us immediately through Discord: https://chat.nhcarrigan.com
If You become aware of any use of Our Software that violates this "Do No Harm" principle, You are encouraged to report it to Us immediately through our forums: https://forum.nhcarrigan.com
#### 2.1.5. Consequences of Violation
@ -209,7 +209,7 @@ We reserve the right to enforce the Code of Conduct at Our discretion. Enforceme
#### 2.2.7. Updates to Code of Conduct
Users are responsible for staying informed about any updates to Our Code of Conduct. Significant changes will be communicated through our Discord server: https://chat.nhcarrigan.com
Users are responsible for staying informed about any updates to Our Code of Conduct.
### 2.3. Source Control
@ -1279,7 +1279,7 @@ Previous versions of the License will remain accessible in the commit history fo
## 17. Contact
If you have questions about this License, We may be reached in Our [chat server](https://chat.nhcarrigan.com).
If you have questions about this License, We may be reached in Our [forum](https://forum.nhcarrigan.com).
### 17.1 Communication Channels

72
src/content/docs/legal/privacy.md
View File

@ -28,61 +28,13 @@ By accessing, using, or continuing to use our Services, you explicitly acknowled
The effective date of the current version of this policy will be clearly stated at the beginning of the document. Each revision will be numbered or dated for easy reference.
## 2. Error Logging and Transparency
## 2. Data Collection, Documentation, and User Rights
### 2.1. Public Error Logging
In alignment with our commitment to open source principles, we maintain a policy of transparency regarding application errors and issues. All errors encountered in our Services are logged publicly in our Discord community.
### 2.2. Content of Error Logs
Error logs may include, but are not limited to:
- Timestamp of the error
- Error type and description
- Relevant application or service name
- Non-personally identifiable technical details necessary for troubleshooting
- General user actions that led to the error (without specific user identification)
### 2.3. Potentially Included Information
While we strive to minimize inclusion of personal or sensitive information, error logs may sometimes contain:
- User IDs or usernames (in hashed or partially redacted form)
- IP addresses (in hashed or partially redacted form)
- Device information
- Other technical data relevant to the error
### 2.4. Access to Error Logs
We strongly recommend that all users join our Discord community prior to using our applications. This allows you to:
- Review the types of information being logged
- Understand the frequency and nature of errors
- Participate in discussions about bugs and improvements
### 2.5. Discord Community Access
To join our Discord community and access the error logs, please use the following link: https://chat.nhcarrigan.com
### 2.6. Opt-Out and Data Removal
If you have concerns about information appearing in error logs:
- You may opt-out of using our Services
- You can contact us to request removal of specific log entries, subject to our data retention policies
### 2.7. Continuous Improvement
Public error logging helps us maintain transparency, quickly identify and resolve issues, and continually improve our Services. We appreciate our users' understanding and participation in this process.
## 3. Data Collection, Documentation, and User Rights
### 3.1. Data Collection Practices
### 2.1. Data Collection Practices
We strive to collect only the data necessary for the proper functioning and improvement of our Services. However, the scope of data collection may change as our Services evolve.
### 3.2. Documentation Efforts
### 2.2. Documentation Efforts
We make every effort to maintain accurate and up-to-date documentation regarding our data collection practices. This includes:
@ -90,7 +42,7 @@ We make every effort to maintain accurate and up-to-date documentation regarding
- Timely updates to our privacy policy and related documentation
- Clear communication about significant changes in data collection
### 3.3. Potential Undocumented Data Collection
### 2.3. Potential Undocumented Data Collection
Despite our best efforts, it is possible that at any given time, an application or Service may collect data that is not explicitly documented. This may occur due to:
@ -98,13 +50,13 @@ Despite our best efforts, it is possible that at any given time, an application
- Technical issues or bugs
- Third-party integrations or dependencies
### 3.4. General Data Rights
### 2.4. General Data Rights
Regardless of whether specific data collection is documented, users have the following rights:
#### 3.4.1. Right to Access:
#### 2.4.1. Right to Access:
At any time, you may request a complete copy of your data stored by one of our applications. Requests must be done via our [support server](https://chat.nhcarrigan.com) from the Discord account the data belongs to. This ensures that a user cannot impersonate you and request your data. We may request additional identifying information, depending on the structure of the data collected by the application.
At any time, you may request a complete copy of your data stored by one of our applications. Requests must be done via `privacy@nhcarrigan.com` from the email address the data belongs to. This ensures that a user cannot impersonate you and request your data. We may request additional identifying information, depending on the structure of the data collected by the application.
#### 3.4.2. Right to Rectification:
@ -112,7 +64,7 @@ You may request corrections to any inaccurate data we hold about you.
#### 3.4.3. Right to Erasure:
At any time, you may request complete removal of your stored data. Requests must be done via our [support server](https://chat.nhcarrigan.com) from the Discord account the data belongs to. This ensures that a user cannot impersonate you and request your data. We may request additional identifying information, depending on the structure of the data collected by the application.
At any time, you may request complete removal of your stored data. Requests must be done via `privacy@nhcarrigan.com` from the email address the data belongs to. This ensures that a user cannot impersonate you and request your data. We may request additional identifying information, depending on the structure of the data collected by the application.
This will **not** opt you out of future data collection unless specifically requested. We reserve the right to refuse removal requests when the data are necessary for specific functionality of the app, in circumstances where removing your data would compromise the functionality for all users.
@ -130,7 +82,7 @@ You may request a copy of your data in a structured, commonly used, and machine-
To exercise any of these rights or to inquire about data we may hold:
- Contact us through our discord server: https://chat.nhcarrigan.com
- Contact us through `privacy@nhcarrigan.com`.
- Be prepared to verify your identity to protect the security of your information
### 3.6. Opting Out of Data Collection
@ -238,9 +190,9 @@ We regularly review and update our data handling practices to ensure the highest
We value transparency and are committed to addressing any questions or concerns you may have regarding our privacy practices. There are several ways to reach us:
### 6.1. Discord Support Server
### 6.1. Forum
For immediate assistance and community support, join our Discord server: https://chat.nhcarrigan.com
For immediate assistance and community support, join our forum: https://forum.nhcarrigan.com
### 6.2. Email Contact
@ -279,7 +231,7 @@ If you are unable to use Discord or email, please visit our website for addition
### 6.8. Updates and Notifications
If you wish to receive updates about changes to our privacy policy or data practices, please join our Discord server: https://chat.nhcarrigan.com
If you wish to receive updates about changes to our privacy policy or data practices, please bookmark this page.
### 6.9. Legal Inquiries

3
src/content/docs/legal/security.md
View File

@ -20,8 +20,7 @@ This policy applies to all applications, services, and systems maintained by our
If you discover a security vulnerability within any of our applications or systems, please report it through one of the following secure channels:
1. Create a private ticket on our [support server](https://chat.nhcarrigan.com)
2. Send an email to `security@nhcarrigan.com`
1. Send an email to `security@nhcarrigan.com`
### 3.2 Public Disclosure Prohibition

2
src/content/docs/legal/terms.md
View File

@ -1151,7 +1151,7 @@ Email: terms@nhcarrigan.com
For other inquiries or concerns, you may also reach us through the following channels:
Email: contact@nhcarrigan.com
Discord: https://chat.nhcarrigan.com
Forum: https://forum.nhcarrigan.com
### 19.3 Business Hours

2
src/content/docs/projects/eslint-config.mdx
View File

@ -181,4 +181,4 @@ If you instead see a failed run with ESlint errors (not linter errors, but packa
Once that has passed successfully (including resolving any linter flags), you can proceed to running `pnpm test` to ensure the existing unit tests pass (and any tests you added to cover new plugins).
As always, feel free to reach out to us in [Discord](https://chat.nhcarrigan.com) if you have any questions!~
As always, feel free to reach out to us on the [forum](https://forum.nhcarrigan.com) if you have any questions!~