Skip to content
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

Closed
jskeet opened this issue Apr 13, 2016 · 3 comments
Closed

Link references in proto files fail in docfx #110

jskeet opened this issue Apr 13, 2016 · 3 comments
Assignees
Labels
documentation priority: p2 Moderately-important priority. Fix may not be included in next release.

Comments

@jskeet
Copy link
Collaborator

jskeet commented Apr 13, 2016

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):

// The response for [google.datastore.v1beta3.Datastore.Lookup][google.datastore.v1beta3.Datastore.Lookup].

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.

@jskeet jskeet self-assigned this Apr 13, 2016
@jskeet jskeet added priority: p2 Moderately-important priority. Fix may not be included in next release. documentation labels Jun 21, 2017
@jskeet
Copy link
Collaborator Author

jskeet commented 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.

@jskeet
Copy link
Collaborator Author

jskeet commented Dec 6, 2017

Closing for now having added this to the backlog

@jskeet jskeet closed this as completed Dec 6, 2017
@amanda-tarafa
Copy link
Contributor

This is now part of a bigger project to improve documentation.
Removing from backlog.

amanda-tarafa added a commit to amanda-tarafa/google-cloud-dotnet that referenced this issue Nov 19, 2020
amanda-tarafa added a commit to amanda-tarafa/google-cloud-dotnet that referenced this issue Nov 19, 2020
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
documentation priority: p2 Moderately-important priority. Fix may not be included in next release.
Projects
None yet
Development

No branches or pull requests

2 participants