diff --git a/webpage/src/pages/contributing.md b/webpage/src/pages/contributing.md index dee706c4..15f55d16 100644 --- a/webpage/src/pages/contributing.md +++ b/webpage/src/pages/contributing.md @@ -1,22 +1,43 @@ # Contributing -1. Fork the [project](https://github.com/m1k1o/neko). +Neko is an open-source project, and we welcome contributions from the community. Whether you're a developer, designer, or user, you can help improve Neko by reporting bugs, suggesting new features, or submitting code changes. -2. Navigate to [.docker/README.md](https://github.com/m1k1o/neko/tree/master/.docker) for further information. +## Reporting issues -3. Edit files in your branch. +If you encounter a bug or have a feature request, please open a new issue on the [GitHub repository](https://github.com/m1k1o/neko/issues). Before opening an issue, please check if a similar issue has already been reported. -4. Submit a pull request explaining the improvements. +When reporting an issue, please provide as much information as possible, including: + +- A detailed description of the problem +- Steps to reproduce the issue +- Expected behavior +- Actual behavior +- Screenshots or error messages (if applicable) +- Your operating system and browser version + +## Contributing code + +If you're a developer and want to contribute code to Neko, follow these steps: + +1. **Fork the [project](https://github.com/m1k1o/neko)**: Create a personal copy of the repository by [forking it](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) to your GitHub account. + +2. **Navigate to [.docker/README.md](https://github.com/m1k1o/neko/tree/master/.docker)**: Follow the instructions in the `.docker/README.md` file for setting up the Docker environment required for development. + +3. **Edit files in your branch**: Make your changes in a new branch created from the `master` branch. Ensure your changes are as well documented and tested. + +4. **Submit a [pull request](https://github.com/m1k1o/neko/pulls)**: Once your changes are ready, submit a pull request with a detailed explanation of the improvements and any relevant information for the reviewers. ## Server build dependencies -If you want to compile Golang code locally, you must install additional dependencies in order for it to compile. +To compile the Golang code locally, you need to install the following dependencies: ```shell apt-get install -y --no-install-recommends libx11-dev libxrandr-dev libxtst-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev ``` -Libclipboard files can be retrieved from `neko_dev_server` container: +### Retrieving Libclipboard files + +Libclipboard files can be retrieved from the `neko_dev_server` Docker container. Run the following commands to copy the necessary files: ```shell mkdir -p /usr/local/lib/pkgconfig/ /usr/local/include/ diff --git a/webpage/src/pages/markdown-page.md b/webpage/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b6..00000000 --- a/webpage/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/webpage/src/pages/non-goals.md b/webpage/src/pages/non-goals.md index e333b6ae..44205811 100644 --- a/webpage/src/pages/non-goals.md +++ b/webpage/src/pages/non-goals.md @@ -1,6 +1,29 @@ # Non Goals -* Turning n.eko into a service that serves multiple rooms and browsers/desktops. - * For multiple room management software, visit https://github.com/m1k1o/neko-rooms. -* Supporting multiple platforms. -* Voice chat, use [Discord](https://discordapp.com/) or [Jitsi](https://meet.jit.si/). +The following are not within the scope of this project: + +**Turning n.eko into a service that serves multiple rooms and browsers/desktops.** +* If you need software for managing multiple rooms, please use [neko-rooms](https://github.com/m1k1o/neko-rooms). + +**Supporting multiple platforms.** +* This project is focused on a specific set of platforms and does not aim to support all possible platforms. +* Only Linux is officially supported. +* If you want to run n.eko on a different platform, you are welcome to try, but we cannot guarantee that it will work. + +**Voice/Video chat integration.** +* For voice chat capabilities, consider using [Discord](https://discordapp.com/) or [Jitsi](https://meet.jit.si/). + +**Screen sharing.** +* Currently is screen sharing not within the scope of this project, but it may be added in the future. +* Use [screego](https://github.com/screego/server) for screen sharing. + +**Mobile support.** +* This project is not optimized for mobile devices. Best-effort support is provided, but it is not a priority. + +:::info +These non-goals help to maintain the focus and quality of the project by setting clear boundaries on what will not be pursued. +::: + +Non-goals are not set in stone and may change over time. If you have a feature request that falls under a non-goal, feel free to open an issue to discuss it. We are always open to feedback and suggestions. + +