diff --git a/docs/assets/favicon.svg b/docs/assets/images/favicon.svg similarity index 100% rename from docs/assets/favicon.svg rename to docs/assets/images/favicon.svg diff --git a/docs/assets/logo.svg b/docs/assets/images/logo.svg similarity index 100% rename from docs/assets/logo.svg rename to docs/assets/images/logo.svg diff --git a/docs/assets/videos/diaper_change_add.mp4 b/docs/assets/videos/diaper_change_add.mp4 new file mode 100644 index 00000000..e70b7387 Binary files /dev/null and b/docs/assets/videos/diaper_change_add.mp4 differ diff --git a/docs/assets/videos/feeding_add.mp4 b/docs/assets/videos/feeding_add.mp4 new file mode 100644 index 00000000..d4916bc6 Binary files /dev/null and b/docs/assets/videos/feeding_add.mp4 differ diff --git a/docs/assets/videos/note_add.mp4 b/docs/assets/videos/note_add.mp4 new file mode 100644 index 00000000..f98eb5e9 Binary files /dev/null and b/docs/assets/videos/note_add.mp4 differ diff --git a/docs/assets/videos/sleep_add.mp4 b/docs/assets/videos/sleep_add.mp4 new file mode 100644 index 00000000..b06769de Binary files /dev/null and b/docs/assets/videos/sleep_add.mp4 differ diff --git a/docs/assets/videos/temperature_add.mp4 b/docs/assets/videos/temperature_add.mp4 new file mode 100644 index 00000000..a92434d7 Binary files /dev/null and b/docs/assets/videos/temperature_add.mp4 differ diff --git a/docs/assets/videos/timer_delete.mp4 b/docs/assets/videos/timer_delete.mp4 new file mode 100644 index 00000000..7b81856a Binary files /dev/null and b/docs/assets/videos/timer_delete.mp4 differ diff --git a/docs/assets/videos/timer_edit.mp4 b/docs/assets/videos/timer_edit.mp4 new file mode 100644 index 00000000..c0ffd37c Binary files /dev/null and b/docs/assets/videos/timer_edit.mp4 differ diff --git a/docs/assets/videos/timer_feeding.mp4 b/docs/assets/videos/timer_feeding.mp4 new file mode 100644 index 00000000..2da6623a Binary files /dev/null and b/docs/assets/videos/timer_feeding.mp4 differ diff --git a/docs/assets/videos/timer_restart.mp4 b/docs/assets/videos/timer_restart.mp4 new file mode 100644 index 00000000..a8c67dcc Binary files /dev/null and b/docs/assets/videos/timer_restart.mp4 differ diff --git a/docs/assets/videos/timer_sleep.mp4 b/docs/assets/videos/timer_sleep.mp4 new file mode 100644 index 00000000..d344a929 Binary files /dev/null and b/docs/assets/videos/timer_sleep.mp4 differ diff --git a/docs/assets/videos/timer_tummy_time.mp4 b/docs/assets/videos/timer_tummy_time.mp4 new file mode 100644 index 00000000..ff1ec497 Binary files /dev/null and b/docs/assets/videos/timer_tummy_time.mp4 differ diff --git a/docs/assets/videos/tummy_time_add.mp4 b/docs/assets/videos/tummy_time_add.mp4 new file mode 100644 index 00000000..b68c08a7 Binary files /dev/null and b/docs/assets/videos/tummy_time_add.mp4 differ diff --git a/docs/assets/videos/weight_add.mp4 b/docs/assets/videos/weight_add.mp4 new file mode 100644 index 00000000..94712301 Binary files /dev/null and b/docs/assets/videos/weight_add.mp4 differ diff --git a/docs/contributing.md b/docs/contributing.md index 7af6c5c1..d033749f 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -120,7 +120,7 @@ documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topic export DJANGO_SETTINGS_MODULE=babybuddy.settings.development This process will differ based on the host OS. The above example is for - Linux-based systems. See [Configuration](/configuration) for other + Linux-based systems. See [Configuration](/docs/setup/configuration.md) for other settings and methods for defining them. 1. Migrate the database diff --git a/docs/import_export.md b/docs/import-export.md similarity index 100% rename from docs/import_export.md rename to docs/import-export.md diff --git a/docs/configuration.md b/docs/setup/configuration.md similarity index 100% rename from docs/configuration.md rename to docs/setup/configuration.md diff --git a/docs/deployment.md b/docs/setup/deployment.md similarity index 97% rename from docs/deployment.md rename to docs/setup/deployment.md index d8990358..19a9cf44 100644 --- a/docs/deployment.md +++ b/docs/setup/deployment.md @@ -4,7 +4,7 @@ The default username and password for Baby Buddy is `admin`/`admin`. For any deployment, **log in and change the default password immediately**. Many of Baby Buddy's configuration settings can be controlled using environment -variables - see [Configuration](/configuration) for detailed information. +variables - see [Configuration](/docs/setup/configuration.md) for detailed information. ## Docker @@ -54,7 +54,7 @@ create the following settings before pushing: heroku config:set DISABLE_COLLECTSTATIC=1 heroku config:set TIME_ZONE= -See [Configuration](/configuration) for other settings that can be controlled +See [Configuration](/docs/setup/configuration.md) for other settings that can be controlled by `heroku config:set`. After an initial push, execute the following commands: diff --git a/docs/user-guide/adding-entries.md b/docs/user-guide/adding-entries.md new file mode 100644 index 00000000..233121be --- /dev/null +++ b/docs/user-guide/adding-entries.md @@ -0,0 +1,75 @@ +# Adding Entries + +## Adding a Diaper Change + + + +From the top navigation bar select the plus sign to add an activity. Select +Diaper Change. If necessary, modify the child or time for the change. Select +whether the diaper is wet, solid, or both, and if add any details such as color, +amount, etc. When complete, select Submit. + +## Adding a Feeding + + + +From the top navigation bar select the plus sign to add an activity. Select +Feeding. If necessary, modify the child, or start/end time for the feeding. +Select the type of food, feeding method, amount, and any notes. When complete, +select Submit. + +## Adding a Note + + + +From the top navigation bar select the plus sign to add an activity. Select +Note. If necessary, modify the child the note is for. Enter any details you want +to remember such as a new food tried or vomiting, etc. Modify the time or date +of note as needed. When complete, select Submit. + +## Adding Sleep + + + +From the top navigation bar select the plus sign to add an activity. Select +Diaper Change. If necessary, modify the child. Select the start time for the +feeding. This time must be prior to the end time. When complete, select Submit. + +## Adding a Temperature + + + +From the top navigation bar select the plus sign to add an activity. Select +Temperature. If necessary, modify the child or time the temperature was taken. +Input the temperature and enter any notes about the instance. When ready, select +Submit. + +## Adding Tummy Time + + + +From the top navigation bar select the plus sign to add an activity. Select +Tummy Time. If necessary, modify the child. Select the start time for the +activity. This time must be prior to the end time. When complete, select Submit. + +## Adding a Weight + + + +From the top navigation bar select the plus sign to add an activity. Select +Weight. If necessary, modify the child or date the child was weighed. Input the +weight and enter any notes about the instance. When ready, select Submit. diff --git a/docs/user-guide/navigating.md b/docs/user-guide/navigating.md new file mode 100644 index 00000000..fc25c777 --- /dev/null +++ b/docs/user-guide/navigating.md @@ -0,0 +1,61 @@ +# Navigating + +## Dashboard + +The Baby Buddy dashboard can be reached by selecting Dashboard on the menu or by +selecting the Baby Buddy icon in the upper left of the menu. The Dashboard lists +an overview of all elements related to your child, including: + +- Last feeding is the time from the start of the last feed and how/where the milk came from (a bottle, or breast). +- Last diaper change is the time the last diaper change was logged and includes the type of diaper. +- Last sleep is the start of the last nap/sleep, and includes the nap duration below. +- Last feeding method is a quick view of how the baby was last fed. This is particularly useful for nursing mothers to remember which breast they started with on the previous feed. +- Today's Feeding is a snapshot of the total numbers of daily feeds. +- Active timers let you know if you have a timer running. +- Statistics is a snapshot of various statistics – these can be scrolled through or select Statistics from the menu bar to see more. +- Today's Sleep lists the total number of hours slept for the day. +- Today's Naps lists the number of naps taken that day in bold and the total nap time below. +- Today's Tummy Time lists the total number of logged tummy time entries and then each individual entry below. +- Diaper Changes provides a view of the diapers logged over the week. Please note that. + +Select the title of any of the cards to see more details. + +## Timeline + +The timeline page lists all your child's activities over time. On the left (or +top on mobile view) is an image of your baby, their name, date of birth, age and +then quick links to dashboard, timeline, reports, edit and delete. + +The timeline lists all activities along with time frames, any notes and the +ability to edit any entry. + +## Measurements + +The Measurements menu provides the option to view and track your baby's +measurements of temperature, weight, height, head circumference and BMI. + +Selecting any of the measurements will open that specific page with all related +measurements listed. + +Add a specific measurement by selecting the add or + measurement. + +## Activities + +The Activities menu provides the option to view and track your baby's activities +such as diaper changes, feedings, sleep, and tummy time. + +Selecting any of the activities will open that activities' page with all details +on recorded activities. + +Add any activity via this menu as well. See [Adding Entries](adding-entries.md) for more +information. + +## Timers + +The Timers menu provides the option to start timers or view all current timers. + +Quick Start Timer starts a brand-new timer. This is the preferred method to +starting timers. + +Start Timer opens a new page to confirm the child the timer is for, name the +timer and update the start time before creating a timer. \ No newline at end of file diff --git a/docs/user-guide/using-timers.md b/docs/user-guide/using-timers.md new file mode 100644 index 00000000..035fc63e --- /dev/null +++ b/docs/user-guide/using-timers.md @@ -0,0 +1,58 @@ +# Using Timers + +## Starting a Timer + +From the top navigation bar select the clock icon to start a timer. A new screen +will appear with a timer, the date and buttons to assign this timer to a +feeding, sleep or tummy time activity. On the bottom of the timer is a red +button to delete the timer, a blue button to edit the timer and add a name or +change the start time, an orange button to restart the timer and a yellow button +to stop the timer. + +## Editing a Timer + + + +## Deleting a Timer + + + +## Creating Entries from Timers + +### Create a Feeding Entry + + + +From the top navigation bar select the clock icon to start a timer. When the +activity is complete, select Feeding. As necessary, modify the child and +start/end time of the timer. Update the feed to reflect the type of feeding +(i.e. breast milk, bottle, etc.), the feeding method and amount. When ready, +select Submit. + +### Create a Sleep Entry + + + +From the top navigation bar select the clock icon to start a timer. When the +activity is complete, select Sleep. As necessary, modify the child and start/end +time of the timer. Add any relevant notes to the sleep. When ready, select +Submit. + +### Create a Tummy Time Entry + + + +From the top navigation bar select the clock icon to start a timer. When the +activity is complete, select Tummy Time. As necessary, modify the child and +start/end time of the timer. Add any relevant tummy time milestones. When ready, +select Submit. diff --git a/mkdocs.yml b/mkdocs.yml index a813123f..e0e9d091 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,14 +1,27 @@ extra_css: - css/extras.css +nav: + - 'index.md' + - 'Setup': + - 'setup/deployment.md' + - 'setup/configuration.md' + - 'User Guide': + - 'user-guide/navigating.md' + - 'user-guide/adding-entries.md' + - 'user-guide/using-timers.md' + - 'import-export.md' + - 'api.md' + - 'contributing.md' theme: name: material - favicon: assets/favicon.svg + favicon: assets/images/favicon.svg features: + - navigation.expand - navigation.instant - navigation.tracking - search.share - search.suggest - logo: assets/logo.svg + logo: assets/images/logo.svg palette: scheme: slate repo_name: babybuddy/babybuddy