Skip to content

Commit 36d03e6

Browse files
authored
feat: Add full bilingual support with automated documentation sync (v1.2.1) (#5)
* refactor: Internationalize all generator outputs to English Change all generated documentation from Chinese to English for broader accessibility. * feat: Internationalize project to English with bilingual support - Add website i18n with language switcher (zh-TW/en) - Convert all code comments and outputs to English - Create bilingual documentation (*.md + *.en.md) - Set English as default language * fix: Resolve test script path and API reference errors * docs: Optimize README for SEO and switch to English as primary language * refactor: Refactor website update script to support full bilingual auto-update * chore: Release version 1.2.1
1 parent 56a9389 commit 36d03e6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+5663
-2340
lines changed

ATTRIBUTIONS.en.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Third-Party Attributions
2+
3+
[繁體中文](./ATTRIBUTIONS.md) | English
4+
5+
This document lists the third-party resources used by n8n-skills and their licensing information.
6+
7+
## Third-Party Resources
8+
9+
### 1. n8n-mcp - n8n Model Context Protocol Integration
10+
11+
n8n-mcp is a project that integrates n8n with Model Context Protocol (MCP), providing AI assistants with the ability to access n8n node information.
12+
13+
- Project Name: n8n-mcp
14+
- Author: Romuald Czlonkowski @ www.aiadvisors.pl/en
15+
- Copyright: Copyright (c) 2024 Romuald Czlonkowski
16+
- License: MIT License
17+
- GitHub: https://github.com/czlonkowski/n8n-mcp
18+
- License Terms: https://github.com/czlonkowski/n8n-mcp/blob/main/LICENSE
19+
20+
#### Scope of Use
21+
22+
This project is developed based on n8n-mcp's architecture and methodology, including:
23+
24+
- Database architecture design
25+
- Node parsing logic
26+
- MCP tool definitions
27+
- Validation mechanisms
28+
29+
#### Acknowledgments
30+
31+
This project is built upon the foundation of n8n-mcp, created by Romuald Czlonkowski @ [www.aiadvisors.pl/en](https://www.aiadvisors.pl/en).
32+
33+
If you use this package in your project, we recommend including the following acknowledgment:
34+
35+
```
36+
Built with n8n-mcp (https://github.com/czlonkowski/n8n-mcp)
37+
Created by Romuald Czlonkowski @ www.aiadvisors.pl/en
38+
```
39+
40+
---
41+
42+
## Other Dependency Packages
43+
44+
This project uses the following npm packages:
45+
46+
### Runtime Dependencies
47+
48+
- n8n-workflow - n8n workflow core functionality
49+
- License: Sustainable Use License
50+
- Copyright: (c) 2024 n8n GmbH
51+
52+
- n8n-core - n8n core functionality
53+
- License: Sustainable Use License
54+
- Copyright: (c) 2024 n8n GmbH
55+
56+
### Development Dependencies
57+
58+
- TypeScript - Maintained by Microsoft
59+
- License: Apache License 2.0
60+
61+
- Jest - Testing framework
62+
- License: MIT License
63+
64+
- ESLint - Code linting tool
65+
- License: MIT License
66+
67+
For detailed dependency package license information, please refer to each package's LICENSE file.
68+
69+
---
70+
71+
## Trademark Notice
72+
73+
- n8n is a registered trademark of n8n GmbH
74+
- All other mentioned trademarks belong to their respective owners
75+
- This project is not affiliated with, endorsed, or sponsored by n8n GmbH
76+
77+
---
78+
79+
## Contact Information
80+
81+
For any questions regarding licensing information, please contact:
82+
83+
- n8n Official: https://n8n.io/contact
84+
- n8n-mcp Author: Romuald Czlonkowski @ www.aiadvisors.pl/en
85+
86+
---
87+
88+
## License Compliance
89+
90+
This project is committed to complying with all relevant license terms. If you discover any licensing issues, please notify us immediately.
91+
92+
Last Updated: 2025-10-31

CHANGELOG.en.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Changelog
2+
3+
[繁體中文](./CHANGELOG.md) | English
4+
5+
This file documents all notable changes to this project.
6+
7+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
8+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
10+
## [Unreleased]
11+
12+
## [1.2.1] - 2025-11-07
13+
14+
### Changed
15+
- Refactor website update script to support full bilingual auto-update
16+
- Add auto-update functionality for README.md and README.zh-TW.md
17+
- Add auto-update functionality for website/locales/en.json and zh-TW.json
18+
- Improve index.html update logic with data-i18n attribute matching, remove hardcoded Chinese dependencies
19+
- Distinguish actual node count (from nodes.json) from output file count (from validation-report.json)
20+
- Centralize all update data management (node count, template count, version, date, file statistics)
21+
- Ensure English and Chinese content auto-sync, reducing maintenance overhead
22+
23+
## [1.2.0] - 2025-11-04
24+
25+
### Changed
26+
- Implemented node layered merging strategy, significantly reducing output file count
27+
- Optimized Skill.md content for better Claude understanding and file searching
28+
29+
## [1.1.0] - 2025-11-03
30+
31+
### Added
32+
- Complete open source project documentation (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md)
33+
- Added comprehensive project metadata in package.json
34+
- Added prominent license notice in README.md
35+
- Added copyright notices in source code
36+
37+
### Changed
38+
- Adjusted GitHub Actions architecture: update workflow only updates source code, release workflow handles building
39+
- .gitignore excludes data/ and output/ directories (build artifacts)
40+
41+
### Fixed
42+
- Fixed workflow responsibility separation to avoid duplicate builds
43+
44+
## [1.0.0] - 2025-10-31
45+
46+
### Added
47+
- Initial release
48+
- Collect node information from n8n npm packages (540+ nodes)
49+
- Collect usage statistics from n8n.io Templates API
50+
- Priority ranking system (based on usage frequency, documentation completeness, community popularity)
51+
- Category organizer (core, app, trigger, ai, database, utility)
52+
- Node grouper (by functional groups and usage frequency)
53+
- Skill.md main file generator
54+
- Resource file generator (resources/*.md)
55+
- Validators (Skill format validation, completeness checking)
56+
- Support for n8n v1.117.2
57+
58+
### GitHub Actions
59+
- Auto-update workflow (weekly n8n update checks)
60+
- Build validation workflow (runs on PR and push)
61+
- Release workflow (auto-creates GitHub Release)
62+
63+
### Documentation
64+
- Complete README.md
65+
- LICENSE (MIT) and ATTRIBUTIONS.md (third-party license declarations)
66+
- PROJECT_STATUS.md (project status report)
67+
- CLAUDE.md (Claude Code development guide)
68+
- Detailed documentation for each module (USAGE.md, ORGANIZERS_QUICKSTART.md, etc.)
69+
70+
### Technical
71+
- TypeScript 5.3+ (strict mode)
72+
- Modular design (collectors, parsers, organizers, generators, validators)
73+
- Complete type definitions
74+
- Jest testing framework
75+
- ESLint code linting
76+
77+
---
78+
79+
## Version Guidelines
80+
81+
### Version Numbering Rules
82+
83+
- MAJOR: Incompatible API changes or n8n major version upgrade
84+
- MINOR: Backward compatible feature additions or n8n minor version upgrade
85+
- PATCH: Backward compatible bug fixes or data updates
86+
87+
### Tag Descriptions
88+
89+
- `Added`: New features
90+
- `Changed`: Changes to existing functionality
91+
- `Deprecated`: Features to be removed soon
92+
- `Removed`: Removed features
93+
- `Fixed`: Bug fixes
94+
- `Security`: Security-related fixes

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@
77

88
## [Unreleased]
99

10+
## [1.2.1] - 2025-11-07
11+
12+
### Changed
13+
- 重構網站更新腳本以支援完整雙語自動更新
14+
- 新增 README.md 和 README.zh-TW.md 自動更新功能
15+
- 新增 website/locales/en.json 和 zh-TW.json 自動更新功能
16+
- 改進 index.html 更新邏輯,使用 data-i18n 屬性匹配,移除硬編碼中文依賴
17+
- 區分實際節點數(從 nodes.json)和輸出檔案數(從 validation-report.json)
18+
- 統一管理所有更新資料(節點數、範本數、版本號、更新日期、檔案統計)
19+
- 確保中英文文件內容自動同步,降低維護成本
20+
1021
## [1.2.0] - 2025-11-04
1122

1223
### Changed

CODE_OF_CONDUCT.en.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Code of Conduct
2+
3+
[繁體中文](./CODE_OF_CONDUCT.md) | English
4+
5+
## Our Pledge
6+
7+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to creating a positive environment include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
22+
- Trolling, insulting/derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Our Responsibilities
28+
29+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
30+
31+
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team through:
40+
41+
- Creating an Issue on GitHub (for public violations)
42+
- Directly contacting project maintainers (for sensitive issues)
43+
44+
All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
45+
46+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
47+
48+
## Attribution
49+
50+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1,
51+
available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
52+
53+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
54+
55+
For answers to common questions about this code of conduct, see the FAQ at
56+
https://www.contributor-covenant.org/faq. Translations are available at
57+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)