This docs directory helps contributors and new developers understand the project quickly and collaborate safely.
The main repository is maintained by the GitHub organization notionnext-org (canonical: https://github.com/notionnext-org/NotionNext). You are welcome to request org membership when that fits your role. If you cloned before the transfer, run:
git remote set-url origin https://github.com/notionnext-org/NotionNext.gitSee Contributing (and the Chinese contributing guide) for details.
| Topic | English | 中文 |
|---|---|---|
| Getting Started | GETTING_STARTED.en.md | GETTING_STARTED.md |
| Architecture | ARCHITECTURE.en.md | ARCHITECTURE.md |
| Project Structure | PROJECT_STRUCTURE.en.md | PROJECT_STRUCTURE.md |
| Configuration | CONFIGURATION.en.md | CONFIGURATION.md |
| Contribution Workflow | CONTRIBUTION_WORKFLOW.en.md | CONTRIBUTION_WORKFLOW.md |
| Maintenance & change control | MAINTENANCE_PHILOSOPHY.en.md | MAINTENANCE_PHILOSOPHY.zh-CN.md |
| Theme Migration Guide | THEME_MIGRATION_GUIDE.md | THEME_MIGRATION_GUIDE.zh-CN.md |
- Reduce onboarding cost for contributors.
- Keep collaboration rules consistent.
- Prevent personal/local config leaks.
- Keep PR reviews focused on real logic changes.
- Root
README.md: project overview and showcase - Root
CONTRIBUTING.md: public contribution entry - Root
DEVELOPMENT.md: commands and tooling docs/: architecture, configuration, and workflow details