Skip to content

fix(docs improvements) #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Carloshsc wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(docs improvements) #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,25 +154,6 @@ const config = {
src: "img/logo.svg",
},
},
footer: {
style: "light",
links: [
{
title: "Links",
items: [
{
label: "Elos",
href: "https://elos.vc/",
},
{
label: "About Mconf",
href: "https://elos.vc/site/sobre-a-mconf/",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Elos `,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
Expand Down
2 changes: 1 addition & 1 deletion pages/EnglishGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ Suggestions are very welcome at any time. Feel free to contact us whenever you w

- Elos will allow you to implement a business logic designed by you;
- You won't need to register users or rooms in Elos, this will be done via API at the time of access;
- Each room is identified by a `meetingID` generated by you, preferably a UUID;
- Each room is identified by a `meetingID` generated by you, preferably a GUID;
- Determine which entity in your system each room will be linked to - be it a class, an appointment or an agent;
- Generate a `meetingID` for each entity and save it in the database;
- You are not expected to have to deal with the complexity of generating API URLs - use a ready-made library for this (see [here](https://www.notion.so/Documenta-o-API-Elos-327d7f8f72894c5480cf2fa7804ef7bb?pvs=21));
Expand Down
2 changes: 1 addition & 1 deletion pages/Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ Sugestões são muito bem-vindas, a qualquer momento. Sinta-se à vontade para c

- O Elos permitirá que você implemente uma lógica de negócio pensada por você;
- Você não precisará cadastrar usuários ou salas no Elos, isso será feito via API no momento do acesso;
- Cada sala é identificada por um `meetingID` gerado por você, preferencialmente um UUID;
- Cada sala é identificada por um `meetingID` gerado por você, preferencialmente um GUID;
- Determine a qual entidade no seu sistema estará vinculada cada sala - seja uma turma, seja um agendamento, seja um agente;
- Gere um `meetingID` para cada entidade e grave no banco;
- Não é esperado que você precise lidar com a complexidade de geração das URLs da API - utilize uma biblioteca pronta pra isso (veja [aqui](https://www.notion.so/Documenta-o-API-Elos-327d7f8f72894c5480cf2fa7804ef7bb?pvs=21));
Expand Down
33 changes: 33 additions & 0 deletions src/theme/ColorModeToggle/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from "react";
import useIsBrowser from "@docusaurus/useIsBrowser";
import { useColorMode } from "@docusaurus/theme-common";
import styles from "./styles.module.css";

export default function ColorModeToggle() {
const isBrowser = useIsBrowser();
const { colorMode, setColorMode } = useColorMode();

const handleToggle = () => {
setColorMode(colorMode === "dark" ? "light" : "dark");
};

if (!isBrowser) {
return null;
}

return (
<div className={styles.toggleContainer}>
<input
type="checkbox"
id="theme-toggle"
className={styles.toggleCheckbox}
checked={colorMode === "dark"}
onChange={handleToggle}
aria-label="Toggle between light and dark mode"
/>
<label htmlFor="theme-toggle" className={styles.toggleLabel}>
<span className={styles.toggleButton} />
</label>
</div>
);
}
108 changes: 108 additions & 0 deletions src/theme/ColorModeToggle/styles.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
.toggleContainer {
display: inline-flex;
align-items: center;
justify-content: center;
padding: 4px;
}

.toggleCheckbox {
display: none;
}

.toggleLabel {
position: relative;
width: 70px;
height: 35px;
background-color: white;
border: 2px solid #eaeaea;
border-radius: 45px;
cursor: pointer;
transition: background-color 0.3s ease, border-color 0.3s ease;
display: flex;
align-items: center;
padding: 4px;
}

.toggleLabel:hover {
background-color: #f5f5f5;
}

.toggleButton {
position: absolute;
width: 27px;
height: 27px;
background-color: black;
border-radius: 50%;
transition: transform 0.3s ease, background-color 0.3s ease;
left: 4px;
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2);
}

.toggleCheckbox:checked + .toggleLabel {
background-color: #333;
border: 2px solid #333;
}

.toggleCheckbox:checked + .toggleLabel:hover {
background-color: #222;
}

.toggleCheckbox:checked + .toggleLabel .toggleButton {
background-color: white;
transform: translateX(31px);
}

.toggleCheckbox:focus + .toggleLabel {
outline: 2px solid var(--ifm-color-primary);
outline-offset: 2px;
}

.toggleLabel::before {
content: "light_mode";
font-family: "Material Symbols Outlined";
position: absolute;
left: 7px;
top: 50%;
transform: translateY(-50%);
font-size: 21px;
line-height: 1;
transition: opacity 0.3s ease, color 0.3s ease;
color: rgba(0, 0, 0, 0.3);
}

.toggleLabel::after {
content: "dark_mode";
font-family: "Material Symbols Outlined";
position: absolute;
right: 8px;
top: 50%;
transform: translateY(-50%);
font-size: 19px;
line-height: 1;
transition: opacity 0.3s ease, color 0.3s ease, transform 0.3s ease;
color: black;
}

.toggleCheckbox:not(:checked) + .toggleLabel::before {
opacity: 1;
color: white;
z-index: 1;
}

.toggleCheckbox:not(:checked) + .toggleLabel::after {
opacity: 0.3;
color: rgba(0, 0, 0, 0.3);
}

.toggleCheckbox:checked + .toggleLabel::before {
opacity: 0.3;
color: rgba(255, 255, 255, 0.3);
}

.toggleCheckbox:checked + .toggleLabel::after {
opacity: 1;
color: black;
z-index: 1;
right: 7px;
font-size: 21px;
}
27 changes: 26 additions & 1 deletion src/theme/Layout/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ export default function LayoutWrapper(props) {
href="https://ajuda.elos.vc/kb/article/150995/tudo-sobre-o-elos"
target="_blank"
>
<MaterialIcon>indeterminate_question_box</MaterialIcon>{" "}
<MaterialIcon>indeterminate_question_box</MaterialIcon>
Help Center
</a>
</li>
Expand All @@ -739,6 +739,31 @@ export default function LayoutWrapper(props) {
</a>
</li>
</CollapsibleCategory>

<CollapsibleCategory
label="Links"
defaultOpen={true}
searchQuery={searchQuery}
>
<li className="menu__list-item">
<a
className="menu__link"
href="https://elos.vc/site/"
target="_blank"
>
<MaterialIcon>link</MaterialIcon>
Elos
</a>
</li>
<li className="menu__list-item">
<a
className="menu__link"
href="https://elos.vc/site/sobre-a-mconf/"
>
<MaterialIcon> link </MaterialIcon> About Mconf
</a>
</li>
</CollapsibleCategory>
</ul>
</nav>
</div>
Expand Down
32 changes: 16 additions & 16 deletions static/proxy/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ paths:
parameters:
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -442,7 +442,7 @@ paths:
example: "2024-10-21"
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -749,7 +749,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -795,7 +795,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -1262,7 +1262,7 @@ paths:
default: false
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -1636,7 +1636,7 @@ paths:
default: false
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -1780,7 +1780,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -1896,7 +1896,7 @@ paths:
type: boolean
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2023,7 +2023,7 @@ paths:
type: integer
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2241,7 +2241,7 @@ paths:
type: boolean
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2288,7 +2288,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2344,7 +2344,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2401,7 +2401,7 @@ paths:
default: false
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2454,7 +2454,7 @@ paths:
parameters:
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2537,7 +2537,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down Expand Up @@ -2583,7 +2583,7 @@ paths:
type: string
- name: checksum
in: query
description: SHA-1 value calculated for validation in the API.
description: SHA-256 value calculated for validation in the API.
required: true
schema:
type: string
Expand Down