From 490a9b11d6051a917837fffc6f74e32ca171506e Mon Sep 17 00:00:00 2001 From: realaravinth Date: Tue, 26 Apr 2022 18:46:32 +0530 Subject: [PATCH] feat: add docs to add new Hostea Doctor --- docs/gitea-clinic-new-doctor.md | 43 +++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/gitea-clinic-new-doctor.md diff --git a/docs/gitea-clinic-new-doctor.md b/docs/gitea-clinic-new-doctor.md new file mode 100644 index 0000000..213e142 --- /dev/null +++ b/docs/gitea-clinic-new-doctor.md @@ -0,0 +1,43 @@ +# Add new Hostea Doctor to Gitea Clinic section: + +1. Add the following template to + [`clinic-doctors.toml`](../data/clinic-doctors.toml) and fill in the + Doctor details: + +```toml +## ------------- batman --------- +[[ doctors ]] +nick = "batman" +name ="Bruce Wayne" +website = "https://bat.example.com" + +## ------------- start batman --------- +``` + +2. Optionally, add Doctor's photo: + + i. Add photo to [`../static/people`](../static/people) + + ii. Add photo filename to Doctor's section created in step 1: + +```toml +## ------------- batman --------- +[[ doctors ]] +nick = "batman" +name ="Bruce Wayne" +# <-----ADD BELOW LINE TO ADD PHOTO ----> +photo = "static/people/batman.jpg" +# <---------> +website = "https://bat.example.com" + +## ------------- start batman --------- +``` + +## Style Guide + +Please start and end doctor details with the following delimiters: + +```toml +## ------------- start doctor-nick-name --------- +## ------------- start doctor-nick-name --------- +```