Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Feb 5, 2026

Description

Goal

Enable GitHub Wiki deployment while maintaining documentation source in main repo for version control.

Key Changes

  • Created WIKI_MIGRATION.md: Complete migration guide with prerequisites, step-by-step instructions, and troubleshooting
  • Updated README.md: Documentation links now point to GitHub Wiki URLs (https://github.com/altaskur/OpenTimeTracker/wiki/*) instead of local wiki/ paths
  • Fixed wiki/Home.md: Removed references to non-existent pages (User-Guide.md, API-Documentation.md, Release-Notes.md)
  • 12 wiki pages ready: All internal links formatted for GitHub Wiki (no wiki/ prefix)

Type of Change

  • 📝 Documentation update

Impact Assessment

Database Impact

  • No database changes

Backup Impact

  • No impact on backups

Testing

How Has This Been Tested?

  • Manual testing

Test Steps

  1. Verify all wiki files exist and links reference correct pages
  2. Confirm WIKI_MIGRATION.md instructions are complete
  3. Check README.md links point to GitHub Wiki URLs

Test Configuration

  • Node version: N/A
  • npm version: N/A
  • Platform tested: Documentation only

UI Changes

N/A - Documentation only

Checklist

  • My code follows the project's coding standards
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have run npm run lint and fixed any issues
  • I have run npm test and all tests pass
  • I have run npm run test:electron and all tests pass
  • I have run npm run sonar:check and the analysis passes
  • Any dependent changes have been merged and published

Breaking Changes

  • This PR contains breaking changes

Related Issues

N/A

Additional Context

Migration Path:

  1. Enable Wiki in repo settings
  2. Create initial page via web interface
  3. Clone wiki repo: git clone https://github.com/altaskur/OpenTimeTracker.wiki.git
  4. Copy files from wiki/ folder
  5. Push to wiki repo

Source of Truth: Documentation source remains in wiki/ folder, versioned with code. GitHub Wiki serves as published interface.

Files Structure:

wiki/
├── Home.md                    # Entry point
├── Getting-Started.md         # Installation
├── Architecture.md            # Technical design
├── Database-Schema.md         # Data model
├── Development-Setup.md       # Dev environment
├── Build-and-Deployment.md    # Packaging
├── Troubleshooting.md         # Common issues
├── FAQ.md                     # Q&A
├── Contributing.md            # Contributor guide
├── Security.md                # Security policy
├── Roadmap.md                 # Future plans
└── README.md                  # Wiki index

All pages include Spanish translations. Content reflects v1.0.0-alpha.3.

Reviewer Notes

Verify WIKI_MIGRATION.md instructions are clear and complete for maintainer execution.

Original prompt

puedes crear la wiki del proyecto basandote en los estandares de codigo abierto y en la documentacion / codigo del proyecto?


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits February 5, 2026 16:56
…abase Schema

Co-authored-by: altaskur <105789412+altaskur@users.noreply.github.com>
…g wiki pages

Co-authored-by: altaskur <105789412+altaskur@users.noreply.github.com>
Co-authored-by: altaskur <105789412+altaskur@users.noreply.github.com>
Co-authored-by: altaskur <105789412+altaskur@users.noreply.github.com>
Copilot AI changed the title [WIP] Add project wiki based on open source standards docs: create comprehensive bilingual wiki following open source standards Feb 5, 2026
Copilot AI requested a review from altaskur February 5, 2026 17:06
Copilot AI changed the title docs: create comprehensive bilingual wiki following open source standards docs: create comprehensive bilingual wiki in main repository Feb 5, 2026
Copilot AI changed the title docs: create comprehensive bilingual wiki in main repository docs: add comprehensive bilingual wiki in main repository Feb 5, 2026
Co-authored-by: altaskur <105789412+altaskur@users.noreply.github.com>
Copilot AI changed the title docs: add comprehensive bilingual wiki in main repository docs: prepare wiki for GitHub Wiki migration with complete guide Feb 5, 2026
@altaskur altaskur added documentation Improvements or additions to documentation help wanted Extra attention is needed invalid This doesn't seem right question Further information is requested labels Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation help wanted Extra attention is needed invalid This doesn't seem right question Further information is requested

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants