From 31e11b256379aaee86e688ce7c3ef7da8e8a4afd Mon Sep 17 00:00:00 2001 From: DarkSky <25152247+darkskygit@users.noreply.github.com> Date: Sun, 8 Feb 2026 01:16:00 +0800 Subject: [PATCH] chore: polish config & docs (#14392) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #### PR Dependency Tree * **PR #14392** ๐Ÿ‘ˆ This tree was auto-generated by [Charcoal](https://github.com/danerwilliams/charcoal) --- .github/workflows/sync-i18n.yml | 72 ------------------------------ .vscode/settings.template.json | 13 +++--- README.md | 35 +++------------ packages/frontend/i18n/crowdin.yml | 12 ----- 4 files changed, 15 insertions(+), 117 deletions(-) delete mode 100644 .github/workflows/sync-i18n.yml delete mode 100644 packages/frontend/i18n/crowdin.yml diff --git a/.github/workflows/sync-i18n.yml b/.github/workflows/sync-i18n.yml deleted file mode 100644 index 166acdf4d1..0000000000 --- a/.github/workflows/sync-i18n.yml +++ /dev/null @@ -1,72 +0,0 @@ -name: Sync I18n with Crowdin - -on: - push: - branches: - - canary - paths: - - 'packages/frontend/i18n/**' - workflow_dispatch: - -jobs: - synchronize-with-crowdin: - runs-on: ubuntu-latest - permissions: - contents: write - pull-requests: write - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Crowdin action - id: crowdin - uses: crowdin/github-action@v2 - with: - upload_sources: true - upload_translations: false - download_translations: true - auto_approve_imported: true - import_eq_suggestions: true - export_only_approved: true - skip_untranslated_strings: true - localization_branch_name: l10n_crowdin_translations - create_pull_request: true - pull_request_title: 'chore(i18n): sync translations' - pull_request_body: 'New Crowdin translations by [Crowdin GH Action](https://github.com/crowdin/github-action)' - pull_request_base_branch_name: 'canary' - config: packages/frontend/i18n/crowdin.yml - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }} - CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} - i18n-codegen: - needs: synchronize-with-crowdin - runs-on: ubuntu-latest - - permissions: - contents: write - pull-requests: write - - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - ref: l10n_crowdin_translations - - - name: Setup Node.js - uses: ./.github/actions/setup-node - with: - electron-install: false - full-cache: true - - - name: Run i18n codegen - run: yarn affine @affine/i18n build - - - name: Commit changes - run: | - git config user.name "github-actions[bot]" - git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - git add . - git commit -m "chore(i18n): i18n codegen" - git push origin l10n_crowdin_translations diff --git a/.vscode/settings.template.json b/.vscode/settings.template.json index 5521d0b644..7a1b4a2ef0 100644 --- a/.vscode/settings.template.json +++ b/.vscode/settings.template.json @@ -1,5 +1,5 @@ { - "eslint.packageManager": "yarn", + "prisma.pinToPrisma6": true, "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true, "editor.formatOnSaveMode": "file", @@ -14,11 +14,13 @@ "testid", "schemars" ], + "explorer.fileNesting.enabled": true, "explorer.fileNesting.patterns": { "*.js": "${capture}.js.map, ${capture}.min.js, ${capture}.d.ts, ${capture}.d.ts.map", - "package.json": ".browserslist*, .circleci*, .codecov, .commitlint*, .cz-config.js, .czrc, .dlint.json, .dprint.json, .editorconfig, .eslint*, .firebase*, .flowconfig, .github*, .gitlab*, .gitpod*, .huskyrc*, .jslint*, .lighthouserc.*, .lintstagedrc*, .markdownlint*, .mocha*, .node-version, .nodemon*, .npm*, .nvmrc, .pm2*, .pnp.*, .pnpm*, .prettier*, .releaserc*, .sentry*, .stackblitz*, .styleci*, .stylelint*, .tazerc*, .textlint*, .tool-versions, .travis*, .versionrc*, .vscode*, .watchman*, .xo-config*, .yamllint*, .yarnrc*, Procfile, api-extractor.json, apollo.config.*, appveyor*, ava.config.*, azure-pipelines*, bower.json, build.config.*, commitlint*, crowdin*, cypress.*, dangerfile*, dlint.json, dprint.json, firebase.json, grunt*, gulp*, histoire.config.*, jasmine.*, jenkins*, jest.config.*, jsconfig.*, karma*, lerna*, lighthouserc.*, lint-staged*, nest-cli.*, netlify*, nodemon*, nx.*, package-lock.json, package.nls*.json, phpcs.xml, playwright.config.*, pm2.*, pnpm*, prettier*, pullapprove*, puppeteer.config.*, pyrightconfig.json, release-tasks.sh, renovate*, rollup.config.*, stylelint*, tsconfig.*, tsdoc.*, tslint*, tsup.config.*, turbo*, typedoc*, unlighthouse*, vercel*, vetur.config.*, vitest.config.*, webpack*, workspace.json, xo.config.*, yarn*, babel.*, .babelrc, project.json", - "Cargo.toml": "Cargo.lock", - "README.md": "LICENSE, CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md" + "package.json": ".browserslist*, .circleci*, .codecov, .commitlint*, .cz-config.js, .czrc, .dlint.json, .dprint.json, .editorconfig, .eslint*, eslint.*, .firebase*, .flowconfig, .github*, .gitlab*, .gitpod*, .huskyrc*, .jslint*, .lighthouserc.*, .lintstagedrc*, .markdownlint*, .mocha*, .node-version, .nodemon*, .npm*, .nvmrc, .pm2*, .pnp.*, .pnpm*, .prettier*, .releaserc*, .sentry*, .stackblitz*, .styleci*, .stylelint*, .tazerc*, .textlint*, .tool-versions, .travis*, .versionrc*, .vscode*, .watchman*, .xo-config*, .yamllint*, .yarnrc*, Procfile, api-extractor.json, apollo.config.*, appveyor*, ava.config.*, azure-pipelines*, bower.json, build.config.*, commitlint*, dangerfile*, dlint.json, dprint.json, firebase.json, grunt*, gulp*, histoire.config.*, jasmine.*, jenkins*, jest.config.*, jsconfig.*, karma*, lerna*, lighthouserc.*, lint-staged*, nest-cli.*, netlify*, nodemon*, nx.*, package-lock.json, package.nls*.json, phpcs.xml, playwright.config.*, pm2.*, pnpm*, prettier*, pullapprove*, puppeteer.config.*, pyrightconfig.json, release-tasks.sh, renovate*, rollup.config.*, stylelint*, tsconfig.*, tsdoc.*, tslint*, tsup.config.*, turbo*, typedoc*, unlighthouse*, vercel*, vetur.config.*, vitest.*, webpack*, workspace.json, xo.config.*, yarn*, babel.*, .babelrc, project.json, oxlint.json, nyc.config.*", + "Cargo.toml": "Cargo.lock, rust-toolchain*, rustfmt.toml, .taplo.toml", + "README.md": "LICENSE*, CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, README.*", + ".gitignore": ".gitattributes, .dockerignore, .eslintignore, .prettierignore, .stylelintignore, .tslintignore, .yarnignore" }, "[rust]": { "editor.defaultFormatter": "rust-lang.rust-analyzer" @@ -32,5 +34,6 @@ "vitest.include": ["packages/**/*.spec.ts", "packages/**/*.spec.tsx"], "rust-analyzer.check.extraEnv": { "DATABASE_URL": "sqlite:affine.db" - } + }, + "typescript.tsdk": "node_modules/typescript/lib" } diff --git a/README.md b/README.md index adca04fdf9..8776cf9717 100644 --- a/README.md +++ b/README.md @@ -21,23 +21,6 @@

-
- - - - - - - -
- -_Special thanks to [Blaze](https://runblaze.dev) for their support of this project. They provide high-performance Apple Silicon macOS and Linux (AMD64 & ARM64) runners for GitHub Actions, greatly reducing our automated build times._ - -
- -
-
-
Home Page | Discord | @@ -107,10 +90,10 @@ Thanks for checking us out, we appreciate your interest and sincerely hope that ## Contributing -| Bug Reports | Feature Requests | Questions/Discussions | AFFiNE Community | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------- | -| [Create a bug report](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=bug%2Cproduct-review&template=BUG-REPORT.yml&title=TITLE) | [Submit a feature request](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=feat%2Cproduct-review&template=FEATURE-REQUEST.yml&title=TITLE) | [Check GitHub Discussion](https://github.com/toeverything/AFFiNE/discussions) | [Vist the AFFiNE Community](https://community.affine.pro) | -| Something isn't working as expected | An idea for a new feature, or improvements | Discuss and ask questions | A place to ask, learn and engage with others | +| Bug Reports | Feature Requests | Questions/Discussions | AFFiNE Community | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [Create a bug report](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=bug%2Cproduct-review&template=BUG-REPORT.yml&title=TITLE) | [Submit a feature request](https://github.com/toeverything/AFFiNE/issues/new?assignees=&labels=feat%2Cproduct-review&template=FEATURE-REQUEST.yml&title=TITLE) | [Check GitHub Discussion](https://github.com/toeverything/AFFiNE/discussions) | [Visit the AFFiNE Community](https://community.affine.pro) | +| Something isn't working as expected | An idea for a new feature, or improvements | Discuss and ask questions | A place to ask, learn and engage with others | Calling all developers, testers, tech writers and more! Contributions of all types are more than welcome, you can read more in [docs/types-of-contributions.md](docs/types-of-contributions.md). If you are interested in contributing code, read our [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) and feel free to check out our GitHub issues to get stuck in to show us what youโ€™re made of. @@ -169,8 +152,10 @@ Welcome to the AFFiNE blog section! Here, youโ€™ll find the latest insights, tip We would also like to give thanks to open-source projects that make AFFiNE possible: - [Blocksuite](https://github.com/toeverything/BlockSuite) - ๐Ÿ’  BlockSuite is the open-source collaborative editor project behind AFFiNE. +- [y-octo](https://github.com/y-crdt/y-octo) - ๐Ÿ™ y-octo is a native, high-performance, thread-safe YJS CRDT implementation, serving as the core engine enabling the AFFiNE Client/Server to achieve "local-first" functionality. - [OctoBase](https://github.com/toeverything/OctoBase) - ๐Ÿ™ OctoBase is the open-source database behind AFFiNE, local-first, yet collaborative. A light-weight, scalable, data engine written in Rust. -- [yjs](https://github.com/yjs/yjs) - Fundamental support of CRDTs for our implementation on state management and data sync. + +- [yjs](https://github.com/yjs/yjs) - Fundamental support of CRDTs for our implementation on state management and data sync on web. - [electron](https://github.com/electron/electron) - Build cross-platform desktop apps with JavaScript, HTML, and CSS. - [React](https://github.com/facebook/react) - The library for web and native user interfaces. - [napi-rs](https://github.com/napi-rs/napi-rs) - A framework for building compiled Node.js add-ons in Rust via Node-API. @@ -221,12 +206,6 @@ See [BUILDING.md] for instructions on how to build AFFiNE from source code. We welcome contributions from everyone. See [docs/contributing/tutorial.md](./docs/contributing/tutorial.md) for details. -## Thanks - -Chromatic - -Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions. - ## License ### Editions diff --git a/packages/frontend/i18n/crowdin.yml b/packages/frontend/i18n/crowdin.yml deleted file mode 100644 index 1d10ad4fcf..0000000000 --- a/packages/frontend/i18n/crowdin.yml +++ /dev/null @@ -1,12 +0,0 @@ -'base_path': '.' -'base_url': 'https://api.crowdin.com' - -'preserve_hierarchy': true - -'files': - [ - { - 'source': '/src/resources/en.json', - 'translation': '/src/resources/%locale%.json', - }, - ]