docs(medcat): Add Medcat Tutorials into public documentation page#417
docs(medcat): Add Medcat Tutorials into public documentation page#417alhendrickson merged 11 commits intomainfrom
Conversation
mart-r
left a comment
There was a problem hiding this comment.
A question regarding the relative paths.
And then concern on 3 places to maintain the same list/table of tutorials.
mart-r
left a comment
There was a problem hiding this comment.
Saw a random typo.
But the other thing is that I do think we need to now link to the tutorials page somewhere. Otherwise someone browsing the repo will have no idea where to go to see the actual tutorials.
| | Part | Title | | ||
| | ---- |-----------------------------------------------------------------------------| | ||
| | 1. | [Migrate a v1 model to v2](notebooks/introductory/migration/1._Migrate_v1_model_to_v2.ipynb) | | ||
| The `medcat-v2` documentation site imports this project’s MkDocs navigation file directly. The relevant plugins are the mkdocs-monorepo-plugin and the mkdocs-jupyter pluign. |
There was a problem hiding this comment.
Fixed.
LLMs wouldnt make this mistake...
|
|
||
| NOTE: These tutorials are aimed at developers and / or people creating their own models. | ||
| For every day usage (e.g inference) the [medcat-scripts](../medcat-scripts) portion would probably be more useful. | ||
| *See the documentation on [index.md](notebooks/index.md) to get started with these tutorials.* |
There was a problem hiding this comment.
I feel like we need a link to the actual tutorials page (the docs page) somewhere as well. We're used to sending people to the tutorials folder of the repo (and other people may have such links set up as well). And this change means that currently they have no idea where to click to in order to get to the table / list of tutorials...
There was a problem hiding this comment.
I've updated the links in these places.
Right now I've just put to "docs.cogstack.org", as I do want to move the page to being at that level (instead of some url like /projects/nlp/something/tutorials) - I'm preferring a vague URL over a dead link at the moment.
modified: medcat-v2-tutorials/README.md
modified: medcat-v2/README.md
modified: medcat-v2/docs/index.md
There was a problem hiding this comment.
A work in progress in term of where the direct access will be, I suppose.
| @@ -0,0 +1,32 @@ | |||
| # MedCAT Tutorials | |||
There was a problem hiding this comment.
Just another comment that I think we need a link to the tutorials in the docs page. Otherwise someone looking at the repo will have no idea where to go from here.
See this link
https://cogstack-platform-toolkit--417.org.readthedocs.build/projects/nlp/en/417/medcat-tutorials/
What this does
All the jupyterhub notebooks in
medcat-v2-tutorialsshould now get rendered on the docs.cogstack.org website.Why?
I'm trying to build out the reference materials for handover. I want to get everything into one place
Details
Next steps