Skip to content

docs(medcat-trainer): Migrate docs to Mkdocs. Update Navigation #353

Merged
alhendrickson merged 13 commits intomainfrom
docs/medcat-trainer/use-mkdocs
Feb 27, 2026
Merged

docs(medcat-trainer): Migrate docs to Mkdocs. Update Navigation #353
alhendrickson merged 13 commits intomainfrom
docs/medcat-trainer/use-mkdocs

Conversation

@alhendrickson
Copy link
Collaborator

@alhendrickson alhendrickson commented Feb 26, 2026

See new version on https://cogstack-platform-toolkit--353.org.readthedocs.build/projects/medcat-trainer/en/353/

Included the suggestions from previous docs PR.

Tried to leave the docs content mostly as is for now.

Two notes:

  1. this doesnt have the python API generation as on https://docs.cogstack.org/projects/medcat-trainer/en/latest/autoapi/index.html . If it's essential we can add it before merging, else I'd do it later - definitely plan to add to medcat (library)
  2. Sticking with Mkdocs/Material for mkdocs, instead of Zensical, even though there's now a big warning as of last week printed - the plugins arent there yet for anything else. I'm assuming we 100% need that api docs for medcat (library), and the others wont support it. Zensical looks slick though.

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

Comment regarding the pyproject.toml for these docs.

Also, as for the API reference, I think it would be good to have it for the client at the very least.

@@ -0,0 +1,19 @@
[project]
name = "cogstack-documentation"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Contextually, this seems documentation for medcat-trainer, specifically, rather than the entire cogstack ecosystem.
Or am I missing something? I.e is this creating the entire thing? If so, perhaps it should be in a different folder?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done - thanks! There was a lot of copy+paste involved in making this PR :D

[project]
name = "cogstack-documentation"
version = "0.1.0"
description = "CogStack Documentation"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

@alhendrickson alhendrickson merged commit e1b66cb into main Feb 27, 2026
9 of 10 checks passed
@alhendrickson alhendrickson deleted the docs/medcat-trainer/use-mkdocs branch February 27, 2026 10:58
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