-
Notifications
You must be signed in to change notification settings - Fork 370
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
Link references in proto files fail in docfx #110
Labels
Comments
jskeet
added
priority: p2
Moderately-important priority. Fix may not be included in next release.
documentation
labels
Jun 21, 2017
This is still important, but we're not expecting to get to it any time soon - it's likely to be a much bigger project than just this. |
Closing for now having added this to the backlog |
This is now part of a bigger project to improve documentation. |
amanda-tarafa
added a commit
to amanda-tarafa/google-cloud-dotnet
that referenced
this issue
Nov 19, 2020
- Removes googleapis#110, googleapis#803 and googleapis#1038 - Adds googleapis#5325
Merged
amanda-tarafa
added a commit
to amanda-tarafa/google-cloud-dotnet
that referenced
this issue
Nov 19, 2020
- Removes googleapis#110, googleapis#803, googleapis#1038 and googleapis#1451 - Adds googleapis#5325
amanda-tarafa
added a commit
that referenced
this issue
Nov 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
This is part of a wider issue around the fact that our code generation creates C# with Markdown instead of XML comments (which isn't pleasant in Visual Studio), but for the most part, docfx just handles that. However, it (understandably) doesn't know how to resolve Markdown reference links. For example, in the Datastore proto we have (for
LookupResponse
):That ends up being rendered as-is, rather than being a link to
Lookup
.I'll investigate how/where we can provide the link target to docfx.
The text was updated successfully, but these errors were encountered: