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

Support explicit example cross-link #3

Open
sgrove opened this issue Jan 4, 2020 · 0 comments
Open

Support explicit example cross-link #3

sgrove opened this issue Jan 4, 2020 · 0 comments

Comments

@sgrove
Copy link
Contributor

sgrove commented Jan 4, 2020

On https://www.onegraph.com/schema/example/GitHubGetPullRequest the link for Add a comment to a Pull Request as a related example erroneously pointed to GitHubAddPullRequestCommentMutation instead of GitHubAddPullRequestComment.

It would be nice to be able to have a uri structure that explicitly linked to other examples in the markdown transform, e.g. examples://GitHubAddPullRequestComment. Then they could be extracted and transformed into the right links, and possibly even fail the build if they link to a missing example (that's not a great user experience).

sgrove added a commit to sgrove/graphql-docs that referenced this issue Jan 8, 2020
…by its `$number`.

Usually users think of "issue OneGraph#10", but most GitHub GraphQL mutations refer to issues by their id, so you'll find this query quite helpful! For example, you'll need the issue id if you want to [Delete a GitHub issue](GitHubDeleteIssue).


To find the id of issue OneGraph#3 on the [OneGraph GraphQL Docs Repository](OneGraph#1), we could pass in the following variables:
  
  ```javascript
  {
    "repoName": "graphql-docs",
    "repoOwner": "OneGraph",
    "number": 3
  }
  ```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant