Skip to content

docs(medcat): Switch Medcat to Mkdocs#361

Merged
alhendrickson merged 7 commits intomainfrom
docs/medcat-docs-mkdocs
Mar 7, 2026
Merged

docs(medcat): Switch Medcat to Mkdocs#361
alhendrickson merged 7 commits intomainfrom
docs/medcat-docs-mkdocs

Conversation

@alhendrickson
Copy link
Copy Markdown
Collaborator

@alhendrickson alhendrickson commented Mar 5, 2026

Left the markdown as is. The main file changes there are needing 4 spaces instead of 2 for bullet lists.

  • API docs are generated and seem right, cross linking together, searchable etc
  • Basic nav setup for the pages added

Preview on https://cogstack-platform-toolkit--361.org.readthedocs.build/projects/nlp/en/361/

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.

Looks good overall.

The only concern I've had for a long time is that the main.md (now index.md) is (mostly) a duplication of the main README for the project. Any chance there's a way to avoid this duplication?
Probably outside the immediate scope of this PR, but something to think about.

@alhendrickson alhendrickson merged commit e5659b8 into main Mar 7, 2026
22 checks passed
@alhendrickson alhendrickson deleted the docs/medcat-docs-mkdocs branch March 7, 2026 13:57
@alhendrickson
Copy link
Copy Markdown
Collaborator Author

Looks good overall.

The only concern I've had for a long time is that the main.md (now index.md) is (mostly) a duplication of the main README for the project. Any chance there's a way to avoid this duplication? Probably outside the immediate scope of this PR, but something to think about.

100% a fair concern!

I've personally wanted to mostly strip out the readmes, and replace with this

  • Top level readme.md is short overview linking to docs
  • Subproject README.md files are basically for developer contributing guides - "I've checked out the project and open the readme file in my IDE, it should probably tell me to uv sync next or whatever" - like stuff that only makes sense when you have it checked out. Everything else in some other docs files

This might cause some duplication though so potentially throw it all in docs/ and only link.

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