linksplatform / linksplatform/Data.Doublets

Implement or find custom xrefService to support references to other packages in the DocFX documentation

Open
#98 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
14
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Should be a replacement for something like this:
```
"xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ]
```
In the `docfx.json`.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the xrefService configuration in docfx.json and determine how references to other packages are currently handled. Define what replacement is needed for the Microsoft xref endpoint, and consider the issue complete when cross-package references resolve through the documented custom service.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.