-
Notifications
You must be signed in to change notification settings - Fork 387
Description
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.