Skip to content
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

Added the Documentation and formal stuff to get the github community standarts #29

Merged
merged 1 commit into from
Nov 10, 2024

Conversation

foxyyyyyyyyyyyyy
Copy link
Contributor

I added the following:

  • Readme Rework
  • Conrtibuting.md
  • Code of Conduct
  • Added the link to the docs in the package

This was linked to issues Nov 3, 2024
@CalumW1 CalumW1 added this to the Version 2.2 milestone Nov 3, 2024
@CalumW1 CalumW1 self-requested a review November 3, 2024 22:47
@CalumW1
Copy link
Owner

CalumW1 commented Nov 3, 2024

Linked this PR to Issue #6 and #30, will review the changes sometime this week.

@foxyyyyyyyyyyyyy
Copy link
Contributor Author

Did you had time to look at it?

Copy link
Owner

@CalumW1 CalumW1 left a comment

Choose a reason for hiding this comment

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

Looks like a good start. I think we spoke about it last weekend but the site will be open source? if new functionality is added then a PR will also need to be raised for doc project? Ill try and sort out a domain for it as well.

@foxyyyyyyyyyyyyy
Copy link
Contributor Author

Yes there would be the need for a pr for the docs project too. But the docs use mdx so you can simply use markdown. If we fix the bundle size issue we can make a mono repo if you want

@foxyyyyyyyyyyyyy
Copy link
Contributor Author

but as an monorepo I can't let my host update it automaticly because it uses github apps for that and they need to be installed to a user or organisation

@CalumW1
Copy link
Owner

CalumW1 commented Nov 8, 2024

but as an monorepo I can't let my host update it automaticly because it uses github apps for that and they need to be installed to a user or organisation

Okay, i think its fine to keep them separate. ill merge this in soon.

@CalumW1 CalumW1 merged commit 04251d9 into CalumW1:main Nov 10, 2024
1 check passed
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.

Update readme to include contribution steps Documentation
2 participants