[Docs/Wiki][Enhancement] Migrate Wiki to github pages deployed by docfx?

[DevTKSS]

Proposal: Migrate Documentation to docfx for Improved Maintainability

Referring to issue #826, where it was mentioned that the co-maintainers currently cannot update or push changes to the Wiki, I would like to propose migrating the Mapster documentation to a docfx-based workflow.

GitHub Wikis often introduce limitations for collaborative maintenance, including the lack of a pull request workflow, limited review capabilities, and no CI integration. A docfx setup would address these aspects and align Mapster with many other .NET projects that use docfx for structured and maintainable documentation.

Benefits of a docfx-based setup

• Full pull request workflow for documentation changes
• Better maintainability and transparency for contributors
• CI-based documentation generation
• Option to publish a GitHub Pages site
• Familiar structure aligned with the .NET ecosystem

Reference Implementation

I have implemented a similar solution in one of my own repositories with community tutorials and Uno Platform learning content:
https://github.com/DevTKSS/DevTKSS.Uno.SampleApps

This setup includes GitHub Actions workflows for building and publishing docfx documentation, which could be adapted for Mapster.

Offer to Contribute

If this proposal is of interest, I would be happy to prepare a pull request that introduces:

• docs/ folder with an initial docfx structure
• GitHub Actions workflow for generating and publishing documentation
• optional GitHub Pages deployment

Thank you for considering this suggestion.

[stagep]

This sounds like a great idea. The primary reason I didn't contribute to the documentation was the limitations that you mention. Would you take the current readme.md and use this as the docs/index.md?

[DevTKSS]

@stagep I am using the Readme of my Repo as Landing Page, you mean that? 🙃
Took me a while to came to the trick for sourcing the images for this file correctly (https://raw.githubusercontent.com Prefix), but now it works 😁

[stagep]

I just meant that we start with the content that we already have rather than nothing. I know nothing about docfx but it sounds better than what Github offers so I am on board. Thanks for bringing some new energy to this repo.

[DocSvartz]

@stagep The current wiki can be cloned to your computer. The only problem is that the repository appears to be corrupted.
I wouldn't want to start from scratch. :)

[DevTKSS]

@DocSvartz What do you mean by "Corrupted"?

[DocSvartz]

[DevTKSS]

@DocSvartz VS2026 or VS Code?
VS2026 is since I installed it half of the time playing hide and seek with gpg on my computer. VS Code then "just" works 🤷 but intellisense in VS202* is better then in VS Code when it comes to Xaml 😅

maybe you want to do a git rebase -i or remove and set your remote origins again 🤔 that would be what I would try if git has its five minutes 👍

PS C:\Users\Sonja\source\repos\Mapster> git status
On branch development
Your branch is up to date with 'mapster-origin/development'.

nothing to commit, working tree clean
PS C:\Users\Sonja\source\repos\Mapster> 

[DocSvartz]

VS2026.
I'm not talking about the mapster repository. I meant the repository in which the Wiki is located.
https://github.com/MapsterMapper/Mapster.wiki.git

The specified git restore seemed to help and the files appeared.

[DevTKSS]

You see you know more about wiki and I maybe more about docfx 👍 Great addition!

[stagep]

If I understand correctly, the concept is to use docfx to create the .md files and we will use the current .md files and the Wiki content for the initial docfx content. This content will then generate .md files and the Wiki would be turned off.

I was unable to use https://github.com/MapsterMapper/Mapster.wiki.git in VS2026 but I was able to use it in VS Code but all I see are 38 pending changes and no files. @DocSvartz when you said "The specified git restore seemed to help and the files appeared.", what did you mean?

[DocSvartz]

I meant was that 38 .md files appeared in the directory where I cloned the wiki. :)
I haven't checked if they match the files displayed. But it seems like one file is missing.

recovery command:

git restore --source=HEAD :/

This file is missing:
https://github.com/MapsterMapper/Mapster/wiki/Mapping-Configuration-With-%22IMapFrom%22-Interface

And as far as I understood from the git report, its addition caused a malfunction in the repository.

[DocSvartz]

@stagep @DevTKSS I meant that you wouldn't have to start docfx content from scratch.

[DevTKSS]

@stagep

I was unable to use https://github.com/MapsterMapper/Mapster.wiki.git in VS2026

🤔 so I think git is sometimes a bit of a comedian🤣
I do get this fail too, the gotten repo seems to be empty, but checking out the git source control in vs code it still shows them, even the one thats marked in this output you showed.
so I would be hopefull that it's possible to restore them 👍
you said 38 files?

You have a great memory! On Point!👍

[stagep]

That is what I got the first time I tried. Now I have the following: