chore: Adding contributing guidelines and code of conduct

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+git@cebbinghaus.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing
+
+## Contributing Guidelines
+
+Thank you for considering contributing to the MicroSDeck project! We welcome any and all contributions, no matter how big or small. Whether you're fixing a typo or refactoring the entire backend, your contributions are valuable to us.
+
+To ensure a positive and inclusive environment, we kindly ask all contributors to adhere to the following guidelines:
+
+### Code of Conduct
+
+Please review and abide by our [Code of Conduct](link-to-code-of-conduct) in all discussions and interactions related to MicroSDeck, both within and outside of GitHub. We strive to maintain a safe and respectful space for everyone involved.
+
+## Getting Started
+This project defines all of its tool dependencies in the `.mise.toml` file in the project root. The [Mise](https://mise.jdx.dev/) tool can be used to install them all with `mise install`. Alternatively it can be used as a reference as to which versions are required. Mise also offers tasks which take over some of the responsibility from `pnpm`, They can be run with `mise run [build|copy|upload]`, Alternatively the build script (located at `/util/build.mjs`) can be invoked with either `./build.sh` or `node --no-warnings=ExperimentalWarning util/build.mjs`, use `-h` to get a list of options.
+
+After the project has built the outputs should have been collected into the `/build` directory which can be zipped up and uploaded to the steamdeck, For this the build script with --upload or the mise `upload` task can be used. 
+
+## Documentation
+
+If you would like to contribute to the MicroSDeck documentation, please ensure that your changes follow the guidelines outlined in the [docs/README.md](docs/README.md).
+
+## Project Layout
+
+### /src
+This is the UI directory in which all logic the user interacts with is present. As every other Decky plugin it is written in Typescript using React as that is what the Steam Client uses for its rendering.
+
+### /lib
+The lib directory contains all of the glue that lets the frontend and backend communicate. It also contains all the type definitions of the backend types and its types are published as an NPM package to allow other plugins to integrate with MicroSDeck.
+
+### /backend
+This is the backend written in Rust. It is responsible for monitoring the filesystem and providing the database and API. It is built with docker from the decky cli which dissallows file binds from outside the backend directory so the version file is located there too.
+
+### /version
+The version file is used to populate all the packages to ensure consistency. The `/util/versioning.mjs` script (also called from `/util/build.mjs`) is responsible for updating the package.json versions. Since the backend cannot access files outside of its own folder the source must be `/backend/version` while `/version` is a symbolic link to allow for easy editing. 
+
+### /docs
+This directory contains all of the MicroSDeck documentation. It is traversed/parsed/rendered in during build by `/src/pages/docs.codegen` which then embeds the docs within the plugin to be rendered by the user. The format is in [mdx](https://mdxjs.com/) which allows for React components to be interleaved with the Markdown making the docs all the more interactive. 

docs/README.md

@@ -1,31 +1,26 @@
 # MicroSDeck Documentation
 
-You have found the source for the MicroSDeck documetnation. Its all within the *.mdx files in this folder.
+Congratulations, you have found the source for the MicroSDeck documentation.
+
+## Contributing
+
+Thank you for considering contributing to the MicroSDeck documentation! We welcome all contributions, no matter how small. Whether it's fixing a typo, improving grammar, or enhancing sentence structure, every contribution is valuable.
+
 
 ## Mdx?
 
-[Mdx](https://mdxjs.com) is a superset of the [Md](https://www.markdownguide.org/) language. Both are human readable markup languages that allow styling of content without much hassle.
+[Mdx](https://mdxjs.com) is a superset of the [Markdown](https://www.markdownguide.org/) language. Both are human readable markup languages that allow styling of content without complex css.
 
 If you have used Markdown them MDX is essentially the same just with some JSX support which allows embedding of custom components into markup files.
 
 If you haven't used markdown, then there is a chance that actually you have. Discord, Reddit, WhatsApp, Discourse & Most Fediverse apps all have markdown support. So if you know how to make text bold in discord, there is a good chance that you know how to make text bold in markdown.
 
-If you haven't ever used any of those apps or never wrote anything but the most basic of unformatted text. Or even if you just want a reference or quick refresher. You can use the following Cheat Sheet to get up to date quickly:
-[https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/)
+If you haven't ever used any of those apps or never wrote anything but the most basic of unformatted text. Or even if you just want a reference or quick refresher. You can use the following Cheat Sheet to get up to date quickly: [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/).
 
 ## JSX?
 
 If you are familiar with Markdown already you might be interested in learning a bit more about these custom components. Through the magic of [Mdx](https://mdxjs.com) we can import React components into the markdown page. These then get rendered together with the page into JSX components that are bundled into the final bundle. 
 
 Since it all ends up as built JSX we can utilize the same exact logic as the rest of the MicroSDeck codebase to retrieve the MicroSDeck instance and any data it contains. Which all get live updated when the state changes. You can check out an [example here](./components/CurrentCard.tsx). 
 
-This allows us to functionally do exactly the same as in the main ui. We can change the name of cards or update any other data we want. Which in the right hands can create a VERY interactive documentation page that both reacts to the state of the plugin as well as allows the users to change it from within the docs (Think a "Try Me" button).
-
-## Contributing
-
-Any and all contributions are welcome. Especially small fixes to correct spelling mistakes, grammer or sentence structure. Nothing is too small and any contributions are welcome. If you do make changes to the docs I ask only that the pullRequest be called `docs: [describe the change]` to keep consistency. 
-
-
-## Thank You
-
-Thank you so much for even reading this far. Now go off & have fun, My rambles surely weren't THAT interesting.
+This allows us to functionally do exactly the same as in the main ui. We can change the name of cards or update any other data we want. Which in the right hands can create a VERY interactive documentation page that both reacts to the state of the plugin as well as allows the users to change it from within the docs (Think a "Try Me" button).