Skip to content

fix: Update docs #756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

adiati98
Copy link
Collaborator

Description

This PR updates contents and links to adjust with the current home of the project.

What type of PR is this? (check all applicable)

  • 🤝 Add a contributor
  • 📝 Documentation Update

Related Issues

Closes #755

Contributors Checklist

I've read through the Getting Started section

  • ✅ Yes
  • ❌ Not yet

Have you run npm run contributors:generate to generate your profile and the badge on the README?

  • ✅ Yes
  • ❌ No

Added to documentation?

  • 📜 README.md
  • 🙅 no documentation needed

Screenshot (Required for PR Review)

[optional] What GIF best describes this PR or how it makes you feel?

@adiati98 adiati98 requested a review from BekahHW May 20, 2025 11:34
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Watched Files

This pull request modifies specific files that require careful review by the maintainers.

Files Matched

  • package-lock.json
  • package.json

Copy link
Contributor

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably add our own COC for the org and link to that.

@adiati98
Copy link
Collaborator Author

adiati98 commented Aug 7, 2025

We should probably add our own COC for the org and link to that.

Yes. I think we better add a .github repository as the home for all things (COC, issue and PR template, etc.) so they'll be added to all org's repos automatically.

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

When we need customized files, we can overwrite them by adding new files in each repo's .github folder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update docs
2 participants