MonoGame/docs.monogame.github.io

Reorganise the repo so support community localisation contributions.

Open

#113 opened on May 11, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (85 forks)auto 404
help wanted

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

The current repo is organised so english is the only language we support. We should reorganise it so that it still supports english, but will allow for community contributions for other languages.

I'm not sure what this would look like but this might be a useful organisation.

/
├── docfx.json
├── en/
│   ├── toc.yml
│   └── articles/
│       └── intro.md
├── fr/
│   ├── toc.yml
│   └── articles/
│       └── intro.md
├── zh/
│   ├── toc.yml
│   └── articles/
│       └── intro.md

All the current content would need to move to the new en folder. The docfx.json would need to be updated as well to add files like so

{
        "files": ["**/*.md", "**/*.yml"],
        "src": "en",
        "dest": "en"
      },
      {
        "files": ["**/*.md", "**/*.yml"],
        "src": "fr",
        "dest": "fr"
      },
      {
        "files": ["**/*.md", "**/*.yml"],
        "src": "zh",
        "dest": "zh"
      }

More research is needed though.

Contributor guide