Refactor UI folder (#2016)

* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons

* refactoring modules/ui

* refactoring modules/ui

* Change folder case

* Fix theme location

* Fix case 2

* Fix storybook

---------

Co-authored-by: Nimra Ahmed <nimra1408@gmail.com>
Co-authored-by: Nimra Ahmed <50912134+nimraahmed@users.noreply.github.com>
This commit is contained in:
Charles Bochet
2023-10-14 00:04:29 +02:00
committed by GitHub
parent a35ea5e8f9
commit 258685467b
732 changed files with 1106 additions and 1010 deletions

View File

@ -1,11 +1,15 @@
---
title: Overview
description: Overview
title: Basics
# description: Overview
sidebar_position: 0
sidebar_custom_props:
icon: TbEyeglass
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
## Tech Stack
We took care of having a clean and simple stack, with minimal boilerplate code.

View File

@ -4,6 +4,9 @@ sidebar_position: 1
sidebar_custom_props:
icon: TbTopologyStar
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
## Pre-requesites

View File

@ -1,9 +1,14 @@
---
title: Design System
sidebar_position: 7
sidebar_custom_props:
icon: TbPaint
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
# Design System
We rely on our internal and custom design system, that is built on top of styled-components.

View File

@ -1,9 +1,14 @@
---
title: Folder Architecture
sidebar_position: 5
sidebar_custom_props:
icon: TbFolder
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
# Folder Architecture
In this guide, you will explore the details of the project directory structure and how it contributes to the organization and maintainability of Twenty.

View File

@ -5,6 +5,10 @@ sidebar_custom_props:
icon: TbBrandFigma
---
import DocCardList from '@theme/DocCardList';
<DocCardList />
Figma is a collaborative interface design tool that aids in bridging the communication barrier between designers and developers.
In this guide, we'll go over how to collaborate with Twentys Figma.

View File

@ -7,6 +7,7 @@ sidebar_custom_props:
icon: TbTerminal2
isSidebarRoot: true
---
Welcome to the Frontend Development section of the documentation.
Here you will find information about the frontend development process, the tools we use, and the best practices we follow.

View File

@ -234,4 +234,8 @@ a.table-of-contents__link:hover{
.tabs-container {
padding: 20px;
}
.card{
text-decoration: none;
}