Improvements to the doc (#1989)

* 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
This commit is contained in:
Nimra Ahmed
2023-10-13 12:13:13 +05:00
committed by GitHub
parent 4e993316a6
commit 13db1bd0a6
21 changed files with 92 additions and 13665 deletions
@@ -15,7 +15,11 @@ We use React and Recoil for state management.
We recommend that you create as many atoms as you need to store your state.
**Rule of thumb:** It's better to use additional atoms than trying to be too concise with props drilling.
:::tip
It's better to use additional atoms than trying to be too concise with props drilling.
:::
```tsx
export const myAtomState = atom({
@@ -1,5 +1,6 @@
---
title: Overview
description: Overview
sidebar_position: 0
sidebar_custom_props:
icon: TbEyeglass
+4 -2
View File
@@ -1,11 +1,13 @@
---
title: Frontend Development
displayed_sidebar: frontendSidebar
sidebar_position: 0
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.
Here you will find information about the frontend development process, the tools we use, and the best practices we follow.
@@ -5,5 +5,4 @@ sidebar_custom_props:
icon: TbBrandFigma
---
WIP
WIP