Skip to content

Merging refget docs.#63

Merged
azangru merged 5 commits intomainfrom
refget-docs-merge
Jan 12, 2024
Merged

Merging refget docs.#63
azangru merged 5 commits intomainfrom
refget-docs-merge

Conversation

@andrewyatz
Copy link
Member

Taken the docs from Beth and integrated with previous PR request. Major changes

  • Fixed error concerning coordinates with refget and Ensembl. Refget is 0-based
  • Added more information about different types of retrieval
  • Added a python notebook example (need to know how to link this)
  • Moved docs to a peer of GraphQL
  • Added information about odd things when using refget and alternative 3rd party clients
  • Added more metadata examples

bethflint and others added 2 commits January 8, 2024 09:38
Taken the docs from Beth and integrated with previous PR request. Major changes

- Fixed error concerning coordinates with refget and Ensembl. Refget is 0-based
- Added more information about different types of retrieval
- Added a python notebook example (need to know how to link this)
- Moved docs to a peer of GraphQL
- Added information about odd things when using refget and alternative 3rd party clients
- Added more metadata examples
@andrewyatz andrewyatz requested a review from bethflint January 8, 2024 18:52
@andrewyatz andrewyatz mentioned this pull request Jan 8, 2024
@azangru
Copy link
Collaborator

azangru commented Jan 8, 2024

@bethflint

Screenshot 2024-01-08 at 22 39 48

@bethflint
Copy link
Contributor

@bethflint
Screenshot 2024-01-08 at 22 39 48

This should be fixed now

bethflint and others added 2 commits January 11, 2024 11:33
Add clarity about genomic coordinates.
@@ -0,0 +1,257 @@
{
Copy link
Collaborator

@azangru azangru Jan 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am confused about the expected fate of this Jupyter notebook file. We don't have any provisions for such files in the help&docs system. We can't show them as an interactive notebook; we don't register them during the build process, which means that we can't even link to them from a help page. You could transform it into a separate markdown file with a huge code block and link to it if you want users to see it. Or we could add a link from a help page to the ipynb file directly in the repo — GitHub runs Jupyter notebooks.

@andrewyatz
Copy link
Member Author

The second option was my feeling as the right way forward. I didn't think GitHub could run a notebook, but could render the notebook. I had assumed once on the main branch, we could create a Binder link which their website seems good at generating.

Main thing is to get it into the repo so we can generate the link. At the moment it will be dead unless we can inject URLs into Markdown files which can have the current build branch injected into the URL

@azangru
Copy link
Collaborator

azangru commented Jan 12, 2024

I didn't think GitHub could run a notebook, but could render the notebook.

Yes, you are right. Sorry; I assumed when I saw the actual checksums in the bottom of the rendered file here that Github actually executed the notebook code 🙂

I had assumed once on the main branch, we could create a Binder link which their website seems good at generating.

Got it! Good idea.

@azangru azangru changed the base branch from refget to main January 12, 2024 16:20
@azangru azangru merged commit b956a20 into main Jan 12, 2024
@azangru azangru deleted the refget-docs-merge branch January 12, 2024 16:25
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

Successfully merging this pull request may close these issues.

3 participants