dotnet / dotnet/docfx

Support multiple versions and languages of documentation

Open
#7,070 11 comments 22 reactions 0 assignees View on GitHub
versioning
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 9m
Merged PRs (30d)
11

Description

Is there guidance or documentation somewhere how I can support API and conceptual documentation for multiple versions of the same library? I am looking for a behaviour that is similar to docs.microsoft.com where you can select the the version of .NET for an API or conceptual article.

Also docs.microsoft.com has multi-language support (e.g. docs.microsoft.com/de-de/). How could I use docfx to add a similar support for multiple languages?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing DocFX's existing documentation and the discussion on this issue, then compare the requested behavior with docs.microsoft.com's version selector and locale paths. Done would be clear guidance or documented support for versioned API and conceptual documentation and multiple languages.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation, internationalization, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.