docs: customizing your organization (#174)

* style: Improved font size of the answers in the FAQ section of the landing page * initial draft of the documentation for customizing organization * made chnages and improved the docs where neccessary
2024-03-01 20:11:33 +01:00
parent 566087978c
commit bae6163f18
6 changed files with 73 additions and 9 deletions
@@ -1,14 +1,78 @@
-import { Callout } from "nextra/components";
+import Image from 'next/image';
+import { Callout, Steps } from 'nextra/components';
+import DommainSetupOne from './images/domain-setup-one.webp';
+import DommainSetupTwo from './images/domain-setup-two.webp';
+import DommainSetupThree from './images/domain-setup-three.webp';
+import CustomizeOrg from './images/customize-organization.webp';

-# Customize your Organization
+# Customize Your Organization

-<Callout emoji='🚨'>
-	This page is a work in progress. Help us expand it by contributing!
+ClassroomIO empowers every organization to tailor their experience to their unique needs. In this guide, you will learn how to customize your organization settings. To access this, from your admin dashboard, navigate to **Settings** > **Organization**.
+
+<Image src={CustomizeOrg} alt="ClassroomIO Organization settings page" quality={100} />
+
+## Update Organization Profile
+
+Easily update your organization's profile by modifying the designated fields in the Organization Profile section of the Settings page. Here, you can update your organization name and logo with your preferred choices.
+
+To update your organization profile details, follow these steps:
+
+<Steps>
+### Go to Organization Settings
+
+From your dashboard, click on Settings, then select Organization in the tabs of the settings page.
+
+### Change Your Organization Name
+
+Fill the Organization name field with your preferred name.
+
+### Click on Upload Image
+
+Click the Upload Image button to select an image for upload.
+
+### Select an Image
+
+Choose a logo or image of your choice from your device.
+
+### Click Update Organization Button
+
+Save the changes by clicking the **Update Organization** button.
+
+</Steps>
+By clicking the **Update Organization** button, the updated preferences in the Organization section will be applied across the entire dashboard.
+
+## Customize Domain
+
+Upon onboarding, each organization in ClassroomIO is assigned a custom Domain URL. This URL directs users to the organization's customizable website, making it easy for audiences to access published courses, FAQs, and other relevant information tailored to your organization's preferences. To customize your organization's domain URL, follow these steps:
+
+<Steps>
+### Click on "Edit Domain"
+
+Click the Edit Domain button to navigate to the domain setup page.
+
+<Image src={DommainSetupOne} alt="Custom Domain setup" quality={100} />
+
+### Update the URL Field with Your Preferred Choice
+
+Fill the field with your desired URL.
+
+<Image src={DommainSetupTwo} alt="Edit Custom domain URL" quality={100} />
+
+### Save Changes
+
+Click on Update Domain to save the changes.
+
+> You can click on **View Site** to be redirected to your Organization website with the updated URL.
+
+<Image src={DommainSetupThree} alt="Edit Custom domain URL" quality={100} />
+
+</Steps>
+
+<Callout type="info" emoji="⏳">
+  Coming soon: Organizations can also integrate existing domain names.
 </Callout>

-## Todo
+## Set Brand Color

- Update name
- Update logo
- Customise Domain
- Set brand color
+We understand that every organization has a preferred color that suits their brand hence we offer organizations the flexibility to choose a theme for their brand from a variety of colors like **blue**, **green**, **orange**, and more.
+To select a brand color for your organization simply click on any of the provided color theme and this would be automatically applied accross your entire application.