search

Redback-Operations / redback-documentation

Docusaurus instance for Redback Operations documentation
MIT License
1 stars 55 forks source link

Initialize Project 2 wiki #100

Closed Cnalhcal closed 1 week ago

Cnalhcal commented 1 week ago

This PR will hopefully cure the Elderly IoT wearable team of their writer's block by providing a firm baseline for each subproject identifying the features goal, its dataset and a summary table of the features and any packages that were identified in the main repo as of 05/09/24.

In the device design folder I have created a basic page out lining the hardware / firmware (heavily based on the readme), As well as a component page providing reasoning and references / datasheets for our components.

Finally, having identified an issue that the jupyter notebooks are written with no consideration for how others might collaborate. I've attempted to alleviate this issue with a best practices file outlining python virtual environments and requirements.txt automated package install lists

Cnalhcal commented 1 week ago

No worries, will update now, thanks! 💯💯💯

Cnalhcal commented 1 week ago

Ahh thank you! Yeah I'm not that around MDX and figured bog standard markdown would do the job but I do like the admonition look. Also where would the best spot be for a feature request? I was keen on including some inline LaTeX and tried including the modules but couldn't get them working working and didn't really want to make changes to back end stuff since JS is not my jam.