Skip to content

docs(medcat): Add Medcat Tutorials into public documentation page#417

Merged
alhendrickson merged 11 commits intomainfrom
feat/medcat-tutorials-mkdocs
Apr 24, 2026
Merged

docs(medcat): Add Medcat Tutorials into public documentation page#417
alhendrickson merged 11 commits intomainfrom
feat/medcat-tutorials-mkdocs

Conversation

@alhendrickson
Copy link
Copy Markdown
Collaborator

@alhendrickson alhendrickson commented Apr 24, 2026

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-tutorials should 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

  • The medcat-v2-tutorials folder now also has a mkdocs.yaml file and setup
  • The medcat docs page now uses the "monorepo" plugin to bring in that other folder, as well as the jupyter plugin to render the pages

Next steps

  • I want to put all the docs in here natively into the docs.cogstack.org page, instead of having to use links to it.
  • I havent actually changed any of the tutorials, readmes etc. But this would probably be worth it - I think when they're shown in a browser in readonly format they start needing a lot more intro/explanation text around them.

Copy link
Copy Markdown
Collaborator

@mart-r mart-r left a comment

Choose a reason for hiding this comment

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

A question regarding the relative paths.

And then concern on 3 places to maintain the same list/table of tutorials.

Comment thread medcat-v2/mkdocs.yml
Comment thread medcat-v2-tutorials/notebooks/index.md Outdated
Comment thread medcat-v2-tutorials/mkdocs.yml
Copy link
Copy Markdown
Collaborator

@mart-r mart-r left a comment

Choose a reason for hiding this comment

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

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.

Comment thread medcat-v2-tutorials/README.md Outdated
| 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.
Copy link
Copy Markdown
Collaborator

@mart-r mart-r Apr 24, 2026

Choose a reason for hiding this comment

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

typo: pluign

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

LLMs wouldnt make this mistake...

Comment thread medcat-v2-tutorials/README.md Outdated

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.*
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

A work in progress in term of where the direct access will be, I suppose.

@@ -0,0 +1,32 @@
# MedCAT Tutorials
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

@alhendrickson alhendrickson merged commit d9d8687 into main Apr 24, 2026
18 checks passed
@alhendrickson alhendrickson deleted the feat/medcat-tutorials-mkdocs branch April 24, 2026 13:34
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.

2 participants