Skip to content

Conversation

@kileyhartigan
Copy link

In this pull request are changes to the 'now-to-update-these-docs' document to include GitHub desktop instructions and to propose a troubleshooting documentation framework/workflow. I then created an example troubleshooting document (about solving a simple mkdocs error) that aligns with the proposed troubleshooting framework.

1. Added to the 'how-to-update-these-docs' to include github desktop instructions and a workflow to contribute to the troubleshooting folder.
Created an example trouble shooting document that follows the trouble shooting framework laid out in the 'how-to-update-to-these-docs' doc.
Trying to figure out how to get the navigation tabs to look the way I want.
Added a possible lit review workflow to how-to-update-these-docs.md
@jonmatthis
Copy link
Contributor

Hey @kileyhartigan - I did a quick video run through with a bunch of unstructured thoughts about this PR: https://youtu.be/XQh7KumcCdw

Easier to just ramble at a camera than try to type it all out :P

(I just uploaded it, so you might need to wait a sec before its ready to view)

How do we want to include publications in this knowledge base? There's an easy way and harder way.
Beginning to build out spinal level reflexes resource library
Adding snippets...
Adding outlines for spinal level reflex papers.
Copy link
Contributor

@jonmatthis jonmatthis left a comment

Choose a reason for hiding this comment

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

This is looking nice!

My main comment before you can merge is that I don't think "Spinal Level Reflexes" should be a 'top level' category. Could you make another category called something like "Literature Review" or something and move the "spinal level reflexes" directory into that?

- Home: index.md
- How to update these docs: how-to-update-these-docs.md
plugins:
- glightbox
Copy link
Contributor

Choose a reason for hiding this comment

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

what does glightbox do?

Copy link
Author

Choose a reason for hiding this comment

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

Copy that Jon, I'll make that adjustment.

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