diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8473727..41ffc85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,46 @@ # Contributing to OnixByte Homepage +This repository holds the company website. It is published openly so that the +Rspress set-up can be read and learned from, but it is **not open for external +contributions**. + +## We do not accept pull requests + +External pull requests are not accepted and will be closed without review. +This is not a comment on the work — it is that a company website is edited by +the people accountable for what it says, and merging outside changes would put +content on the site that nobody here has signed off. + +## Issues are welcome + +Please do open an issue if you spot: + +- a broken or dead link +- something factually wrong, in either language +- a typo, or a place where the British English or Chinese wording is off +- an accessibility problem +- a build or runtime bug you can reproduce + +Issues are read, and genuine problems are usually fixed. If a report turns into +a change, we will make that change ourselves. + +## Licence + +Nothing in this repository is licensed for reuse. See [LICENCE](./LICENCE) — +copyright is retained and no permission is granted to copy, modify or +distribute any part of it. Reading it and linking to it are fine. + +Third-party software this project depends on keeps its own licence; see +[THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md). + +--- + +The rest of this document is for people working on the site internally. + ## Development Setup -This project uses [Rspress](https://rspress.rs) as the static site framework and pnpm as the package manager. +This project uses [Rspress](https://rspress.rs) as the static site framework and +pnpm as the package manager. ```bash pnpm install @@ -23,8 +61,8 @@ theme/ # Custom theme overrides - Write content in both English (British) and Simplified Chinese. British spelling is required throughout — interface text, documentation, code comments and commit messages (`customised`, `centre`, `colour`, and so on). -- Blog posts and documentation articles are licensed under CC-BY-4.0. -- Code contributions are licensed under MIT. +- Marketing pages address the reader as 您; the technical blog keeps the + peer-to-peer 你. ## Navigation and Sidebars @@ -42,8 +80,9 @@ the theme: Do not add a `_meta.json` next to `_nav.json` at the root of a locale directory; doing so collapses the whole site into one flat sidebar. -## Pull Request Process +## Before Committing -1. Ensure the site builds cleanly: `pnpm build` -2. Run linting: `pnpm lint` -3. If adding a new page, include both `en-gb` and `zh-hans` versions. +1. Ensure the site builds: `pnpm build:com` and `pnpm build:cn` +2. Type-check: `pnpm typecheck` +3. Lint and format: `pnpm lint` and `pnpm format` +4. If adding a new page, include both `en-gb` and `zh-hans` versions. diff --git a/LICENCE b/LICENCE index 86f3741..fe0a6b5 100644 --- a/LICENCE +++ b/LICENCE @@ -1,59 +1,31 @@ -MIT Licence +Copyright © 2026 Changsha OnixByte Technology Co., Ltd. +版权所有 © 2026 长沙曜珀科技有限公司 -Copyright (c) 2026 OnixByte +All rights reserved. 保留所有权利。 -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +This repository and its contents — source code, build scripts, theme +components, configuration, and all written content under `docs/` — are the +property of Changsha OnixByte Technology Co., Ltd. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +No licence is granted. No permission is given to use, copy, modify, merge, +publish, distribute, sublicense or sell any part of this repository, in whole +or in part, for any purpose, whether commercial or otherwise. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. - ---- -CC-BY-4.0 - -Copyright (c) 2026 OnixByte - -You are free to: -- Share - copy and redistribute the material in any medium or format for any purpose, - even commercially. -- Adapt — remix, transform, and build upon the material for any purpose, even commercially. - -The licensor cannot revoke these freedoms as long as you follow the license terms. - -Under the following terms: -- Attribution — You must give appropriate credit, provide a link to the license, and indicate - if changes were made. You may do so in any reasonable manner, but not in any way that suggests - the licensor endorses you or your use. - -No additional restrictions — You may not apply legal terms or technological measures that - legally restrict others from doing anything the license permits. - -NOTICES - -You do not have to comply with the license for elements of the material in the public domain or -where your use is permitted by an applicable exception or limitation. - -No warranties are given. The license may not give you all of the permissions necessary for your -intended use. For example, other rights such as publicity, privacy, or moral rights may limit -how you use the material. +This repository is published for reading. You are welcome to read it, to learn +from it, and to link to it. Those things need no permission. --- -This project applies a dual-licensing model: +Third-party components -- Code (source code, build scripts, theme, configuration) is licensed under the MIT License (above). -- Content (blog posts, documentation articles, and other written content under docs/) is licensed under the Creative Commons Attribution 4.0 International License (CC-BY-4.0). +This project depends on third-party software, including Rspress, React, +Rsbuild and Tailwind CSS. Those components remain under their own licences, +and nothing in this notice changes or restricts the rights they grant you. +See THIRD_PARTY_NOTICES.md for the direct dependencies and their terms. -To view a copy of CC-BY-4.0, visit https://creativecommons.org/licenses/by/4.0/ +--- + +Enquiries + +If you would like to use any part of this repository, write to +business@onixbyte.com. diff --git a/package.json b/package.json index ead4851..ba98588 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "onixbyte-homepage", "version": "1.0.0", "private": true, + "license": "UNLICENSED", "type": "module", "packageManager": "pnpm@12.5.1", "engines": {