> For the complete documentation index, see [llms.txt](https://pavewise.gitbook.io/pavewise-style-guide-and-more/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pavewise.gitbook.io/pavewise-style-guide-and-more/frontend/overview.md).

# Overview

A mostly reasonable approach to React, TypeScript, and JSX

**Purpose:**  to provide a foundation for consistency and expectation within the codebase, allowing for efficient and effective code readability, understandability, and maintainability.

***

This style guide is mostly based on the standards that are currently prevalent in React and JavaScript, although some conventions may still be included or prohibited on a case-by-case basis.\
\
Influences from:

* [AirBnB Style Guide](https://github.com/airbnb/javascript/blob/master/react/README.md)
* [StackOverflow Thread](https://stackoverflow.com/questions/43973199/file-naming-conventions-in-reactjs)
* ...

***

## Table of Contents

1. [Config/Tooling](/pavewise-style-guide-and-more/frontend/config-and-tooling.md) (things to improve DX, make you more efficient, etc.)
2. [Workflow](/pavewise-style-guide-and-more/frontend/workflow.md) (creating a new PR, rebasing a PR, etc.)
3. [Basic Guidelines](#basic-rules) (high level JS, React, TypeScript rules/guidelines)
4. [Naming](/pavewise-style-guide-and-more/frontend/naming.md) (file extensions, folders, filenames, declarations)
5. [Our Systems](/pavewise-style-guide-and-more/frontend/our-systems.md) (pages, components, state management, etc.)
6. [👩‍🏫 Learning Resources](/pavewise-style-guide-and-more/frontend/learning-resources.md) (helpful videos for FE/React-related concepts)