Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 35 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<a href="#what-is-opentimetracker">What is</a> •
<a href="#key-features">Key Features</a> •
<a href="#quick-start">Quick start</a> •
<a href="#-documentation">Documentation</a> •
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>
Expand Down Expand Up @@ -87,6 +88,31 @@ npm run dev
npm run dev is the recommended and supported development command.
It runs Angular and Electron together as intended.

---

## 📚 Documentation

**Comprehensive documentation is available in the project wiki:**

### 👉 **[Visit the Wiki](https://github.com/altaskur/OpenTimeTracker/wiki)** 📖

Quick access to key documentation:

- 🚀 **[Getting Started](https://github.com/altaskur/OpenTimeTracker/wiki/Getting-Started)** - Installation and first steps
- 📖 **[User Guide](https://github.com/altaskur/OpenTimeTracker/wiki/Getting-Started)** - Complete feature guide
- 🏗️ **[Architecture](https://github.com/altaskur/OpenTimeTracker/wiki/Architecture)** - Technical design
- 💾 **[Database Schema](https://github.com/altaskur/OpenTimeTracker/wiki/Database-Schema)** - Data model
- 🛠️ **[Development Setup](https://github.com/altaskur/OpenTimeTracker/wiki/Development-Setup)** - Dev environment setup
- 🔧 **[Troubleshooting](https://github.com/altaskur/OpenTimeTracker/wiki/Troubleshooting)** - Common issues and solutions
- ❓ **[FAQ](https://github.com/altaskur/OpenTimeTracker/wiki/FAQ)** - Frequently asked questions
- 🗺️ **[Roadmap](https://github.com/altaskur/OpenTimeTracker/wiki/Roadmap)** - Future plans

All documentation is available in **English** and **Spanish**.

> **Note**: Documentation source files are in the [`wiki/`](wiki/) folder. See [WIKI_MIGRATION.md](WIKI_MIGRATION.md) for instructions on publishing to GitHub Wiki.

---

## 🧪 Project status

⚠️ Alpha stage
Expand All @@ -99,19 +125,19 @@ Feedback, bug reports and contributions are welcome.
## 🤝 Contributing

Interested in contributing? Great ❤️
All contribution-related documentation lives outside this README to keep things clear and up to date.

📘 CONTRIBUTING.md — setup, workflow and quality checks

🧭 COLLABORATION.md — technical and architectural details

🛡️ SECURITY.md — how to report vulnerabilities
**📖 [Visit the Wiki](wiki/Home.md)** for comprehensive documentation.

📜 CODE_OF_CONDUCT.md — community guidelines
All contribution-related documentation lives outside this README to keep things clear and up to date:

🌐 DeepWiki — optional, supplementary documentation (secondary): <https://deepwiki.com/altaskur/OpenTimeTracker>
- 📘 **[CONTRIBUTING.md](CONTRIBUTING.md)** — setup, workflow and quality checks
- 🧭 **[COLLABORATION.md](COLLABORATION.md)** — technical and architectural details
- 🛡️ **[SECURITY.md](SECURITY.md)** — how to report vulnerabilities
- 📜 **[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)** — community guidelines
- 📚 **[Project Wiki](wiki/Home.md)** — comprehensive documentation
- 🌐 **[DeepWiki](https://deepwiki.com/altaskur/OpenTimeTracker)** — optional, supplementary documentation (secondary)

Before opening a PR, please read CONTRIBUTING.md.
Before opening a PR, please read **[CONTRIBUTING.md](CONTRIBUTING.md)**.

## 📄 License

Expand Down
142 changes: 142 additions & 0 deletions WIKI_MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
# Migrating Documentation to GitHub Wiki

This guide explains how to migrate the documentation from the `wiki/` folder to GitHub's native Wiki feature.

## Prerequisites

1. **Enable Wiki** in repository settings:
- Go to: https://github.com/altaskur/OpenTimeTracker/settings
- Scroll to "Features" section
- Check ✅ "Wikis"

2. **Create initial page**:
- Go to: https://github.com/altaskur/OpenTimeTracker/wiki
- Click "Create the first page"
- Title: "Home"
- Content: "Documentation wiki for OpenTimeTracker"
- Click "Save Page"

## Migration Steps

### Step 1: Clone the Wiki Repository

```bash
# Clone the main repository (if not already)
git clone https://github.com/altaskur/OpenTimeTracker.git
cd OpenTimeTracker

# Clone the wiki repository (separate Git repo)
cd /tmp
git clone https://github.com/altaskur/OpenTimeTracker.wiki.git
cd OpenTimeTracker.wiki
```

### Step 2: Copy Wiki Files

```bash
# Copy all markdown files from main repo to wiki repo
cp /path/to/OpenTimeTracker/wiki/*.md .

# Verify files are copied
ls -la
```

### Step 3: Adjust Internal Links

Wiki files need to have links adjusted (remove `wiki/` prefix):

```bash
# Find and replace wiki/ prefix in links
# macOS/Linux:
sed -i 's|](wiki/|](|g' *.md
sed -i 's|](../wiki/|](|g' *.md

# Or manually edit each file to change:
# [Link](wiki/Page.md) → [Link](Page.md)
# [Link](../wiki/Page.md) → [Link](Page.md)
```

### Step 4: Commit and Push

```bash
git add .
git commit -m "docs: migrate documentation to GitHub Wiki"
git push origin master
```

### Step 5: Verify

Visit https://github.com/altaskur/OpenTimeTracker/wiki to verify:
- All pages are visible
- Navigation works
- Links between pages work correctly

### Step 6: Clean Up Main Repository (Optional)

If you want to remove wiki/ from main repo after migration:

```bash
cd /path/to/OpenTimeTracker
git rm -r wiki/
git commit -m "docs: remove wiki folder (migrated to GitHub Wiki)"
git push
```

---

## Alternative: Keep Both

You can keep documentation in both places:

**Main Repo (`wiki/` folder)**:
- ✅ Versioned with code
- ✅ PR review process
- ✅ Works offline
- ✅ Clone with repo

**GitHub Wiki** (separate repo):
- ✅ Native wiki UI
- ✅ Easy web editing
- ✅ Built-in search

**Sync strategy**: Manually copy from `wiki/` to GitHub Wiki when making documentation updates.

---

## Files to Migrate

The following files are ready to migrate:

- `Home.md` - Main wiki entry point
- `Getting-Started.md` - Installation and setup
- `Architecture.md` - Technical architecture
- `Database-Schema.md` - Database documentation
- `Development-Setup.md` - Developer guide
- `Build-and-Deployment.md` - Build process
- `Troubleshooting.md` - Common issues
- `FAQ.md` - Frequently asked questions
- `Contributing.md` - Contribution guide
- `Security.md` - Security policy
- `Roadmap.md` - Future plans
- `README.md` - Wiki index

---

## Troubleshooting

### Wiki not enabled
- Check repository settings → Features → Wikis must be checked

### Permission denied on push
- Ensure you have write access to the repository
- Check GitHub credentials are configured

### Links broken after migration
- Verify all internal links use format `[Text](Page.md)` without `wiki/` prefix
- GitHub Wiki uses page names, not file paths

---

## Questions?

For issues with migration, contact the repository maintainer or open an issue.
Loading