Multilingual document structure

[!NOTE] For the latest implementation status, please refer to Functional Implementation Status (Remaining Functionality).

The EvoSpikeNet documentation site supports both Japanese and English.

📚 Language-specific documentation

Japanese version (default)

• File format: filename.md
• URL: https://evospikenet.readthedocs.io/
• Target: Japanese speakers

English version

• File format: filename.en.md
• URL: https://evospikenet.readthedocs.io/en/
• Target: English speakers

🌐 Available English documentation

Core documentation

Japanese	English	Status
index.md	index.en.md	✅ Completed
overview.md	overview.en.md	✅ Completed
features.md	features.en.md	🔄 Under construction
faq.md	faq.en.md	🔄 Under construction
getting-started/quickstart.md	getting-started/quickstart.en.md	✅ Completed

Implementation notes (artifacts): See docs/implementation/ARTIFACT_MANIFESTS.md for documentation artifact specification (artifact_manifest.json) and CLI flags.

Concept/System Documentation

Japanese	English	Status
EVOSPIKENET_CONCEPTS.md	EVOSPIKENET_CONCEPTS.en.md	✅ Existence
DISTRIBUTED_BRAIN_SYSTEM.md	DISTRIBUTED_BRAIN_SYSTEM.en.md	✅ Existence
ADVANCED_NODE_DISCOVERY.md	ADVANCED_NODE_DISCOVERY.en.md	✅ Existence
ADVANCED_DECISION_ENGINE.md	ADVANCED_DECISION_ENGINE.en.md	✅ Existence
DATA_HANDLING.md	DATA_HANDLING.en.md	✅ Existence

Implementation/SDK

Japanese	English	Status
EvoSpikeNet_SDK.md	EvoSpikeNet_SDK.en.md	✅ Existence
SDK_QUICKSTART.md	SDK_QUICKSTART.en.md	✅ Existence
UserManual.md	UserManual.en.md	✅ Existence

RAG/Analysis

Japanese	English	Status
RAG_SYSTEM_DETAILED.md	RAG_SYSTEM_DETAILED.en.md	✅ Existence
RAG_JAPANESE_PARTICLE_ISSUE.md	RAG_JAPANESE_PARTICLE_ISSUE.en.md	✅ Existence
QUERY_RESPONSE_ANALYSIS.md	QUERY_RESPONSE_ANALYSIS.en.md	✅ Existence

Advanced features

Japanese	English	Status
L5_FEATURE_BREAKDOWN.md	L5_FEATURE_BREAKDOWN.en.md	✅ Existence
L5_EVO_GENOME_IMPLEMENTATION_PLAN.md	L5_EVO_GENOME_IMPLEMENTATION_PLAN.en.md	✅ Existence
LLM_INTEGRATION_STRATEGY.md	LLM_INTEGRATION_STRATEGY.en.md	✅ Existence

others

Japanese	English	Status
SIMULATION_RECORDING_GUIDE.md	SIMULATION_RECORDING_GUIDE.en.md	✅ Existence
P1_P2_ERROR_HANDLING_FIXES.md	P1_P2_ERROR_HANDLING_FIXES.en.md	✅ Existence
DOCUMENTATION_UPDATE_SUMMARY.md	DOCUMENTATION_UPDATE_SUMMARY.en.md	✅ Existence

📊 Multilingualization statistics

Categories	Total number of files	English version available	Coverage
Core Document	10	4	40%
Concept/System	15	10	67%
Implementation/SDK	20	8	40%
RAG/Analysis	8	6	75%
Advanced Features	12	8	67%
Other	36	15	42%
Total	101	51	~50%

🎯 Translation plan by priority

Phase 1: Required Documents (Priority: High)✅

• ✅ index.en.md
• ✅ overview.en.md
• ✅ getting-started/quickstart.en.md
• 🔄 features.en.md
• 🔄 faq.en.md

Phase 2: User Guide (Priority: High)

• [ ] getting-started/installation.en.md
• [ ] getting-started/first_simulation.en.md
• [ ] guides/web_ui.en.md
• [ ] guides/training.en.md

Phase 3: Reference (Priority: Medium)

• [ ] reference/api_reference.en.md
• [ ] reference/module_reference.en.md
• [ ] reference/configuration.en.md

Phase 4: Contribution Guide (Priority: Medium)

• [ ] contributing/guidelines.en.md
• [ ] contributing/development_setup.en.md
• [ ] contributing/coding_standards.en.md
• [ ] contributing/license.en.md
• [ ] contributing/support.en.md

Phase 5: Advanced Topics (Priority: Low)

• Many existing .en.md files exist
• Update as needed

🔧 Language switching function

Setting Material for MkDocs

mkdocs.yml settings:

extra:
  alternate:
    - name: 日本語
      link: /
      lang: ja
    - name: English
      link: /en/
      lang: en

In-page language links

Add language switch link at the top of each document:

Japanese version:```markdown 🇺🇸 English | 🇯🇵 日本語

**English version:**```markdown
🇺🇸 English | [🇯🇵 日本語](index.md)

📝 Translation guidelines

Unified terminology

Japanese	English
Spiking Neural Network (SNN)
Distributed Brain System
Evolutionary Learning
Federated Learning
RAG System	RAG System
Neuron	Neuron
Synapse
Spike	Spike
Membrane Potential
Firing / Spike

Style Guide

Japanese: - Masu style - Technical terms are written in English (when first published) - Example: Spiking Neural Network (SNN)

English: - Technical but accessible -Use active voice - Include code examples - Define acronyms on first use

🚀 Steps when creating a new document

1. Create Japanese version

# Create new document
vim docs/new_feature.md

2. Create English version

# Create English version
vim docs/new_feature.en.md

3. Add mutual link

new_feature.md (Japanese version):```markdown 🇺🇸 English | 🇯🇵 日本語

New feature title

...

**new_feature.en.md (English version):**```markdown
🇺🇸 English | [🇯🇵 日本語](index.md)

# New Feature Title
...

4. Add to mkdocs.yml

nav:
  - セクション名:
    - 日本語タイトル: new_feature.md

The English version automatically recognizes .en.md.

🔍 Search function

Multilingual search

mkdocs.yml search settings:

plugins:
  - search:
      lang:
        - ja
        - en
      separator: '[\s\-\.]+'

Features: - Searchable in both Japanese and English - Japanese search using morphological analysis - English stemming supported

📊 Current multilingualization status

Completeness

全体の多言語化率: ~50%
├─ コアドキュメント: 40% (4/10)
├─ 概念・システム: 67% (10/15)
├─ 実装・SDK: 40% (8/20)
├─ RAG・分析: 75% (6/8)
├─ 高度な機能: 67% (8/12)
└─ その他: 42% (15/36)

New creation (this session)

• ✅ docs/index.en.md - English version homepage
• ✅ docs/overview.en.md - English version project overview
• ✅ docs/getting-started/quickstart.en.md - English version quickstart

🎯 Next steps

Short-term goals (within 1 week)

1. Completion of features.en.md
2. Translation of faq.en.md
3. Creating installation.en.md
4. Creating first_simulation.en.md

Mid-term goal (within 1 month)

1. English translation of all user guides
2. English translation of API/SDK documentation
3. English translation of reference documents

Long-term goals (within 3 months)

1. English version of all documents completed
2. Building an automatic translation pipeline
3. Synchronous maintenance of multilingual documents

🤝 Contribution

Contributing to translation

We welcome your contributions to the creation and improvement of the English version of the documentation!

Steps: 1. Declare translation plans in GitHub Issues 2. Perform translation work 3. Create a pull request 4. Review/Merge

Reward: - Recognized as a contributor - Name listed in README - Priority Support (5+ PR)

📞 Contact Us

For questions and suggestions regarding multilingualization:

• GitHub Discussions: Questions/Discussions
• Email: maoki@moonlight-tech.biz
• Issue: Translation request

---

Last updated: December 17, 2025 Multilingualization rate: ~50% (51/101 files)

Status: Phase 1 completed, Phase 2 in progress