Skip to content

Reorganise the repo so support community localisation contributions. #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dellis1972 opened this issue May 11, 2025 · 0 comments
Open
Labels
help wanted Extra attention is needed

Comments

@dellis1972
Copy link
Contributor

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.

@dellis1972 dellis1972 added the help wanted Extra attention is needed label May 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant