Skip to content

Commit

Permalink
Move docs overview to main README (#1616)
Browse files Browse the repository at this point in the history
* Move documentation overview to main README.md

* Remove incorrect note
  • Loading branch information
robines authored Nov 15, 2024
1 parent ba566b0 commit c645157
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 58 deletions.
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,54 @@

Samfundet4 is the latest and greatest iteration of samfundet.no. It's built using Django and React.

## Documentation

Looking for install guides and technical documentation? Go to the [Documentation Overview](./docs/README.md)!
## Documentation Overview

> [!TIP]
> If you're new, start by going through the [Introduction to Samfundet4](./docs/introduction.md) guide.
### Frontend

- [Creating react components (conventions)](./docs/technical/frontend/components.md)
- [Forms and schemas](./docs/technical/frontend/forms.md)
- [*Deprecated: SamfForm*](./docs/technical/frontend/samfform.md)
- [Cypress Setup Documentation](./docs/technical/frontend/cypress.md)
- [Data fetching and State management](./docs/technical/frontend/data-fetching.md)

### Backend

- [🌐 API documentation](./docs/api-docs.md)
- [Billig (payment system)](./docs/technical/backend/billig.md)
- [Seed scripts](./docs/technical/backend/seed.md)
- [Role system](./docs/technical/backend/rolesystem.md)

### Other

- [Automatic Interview Scheduling](./docs/intervew-scheduling.md)

### Workflow

- [Work Methodology](./docs/work-methodology.md)
- How to contribute to the project
- [Useful Commands](./docs/useful-commands.md)
- [Useful Docker aliases](./docs/docker-project-specific-commands.md)
- [Common error messages](./docs/common-errors.md)

### Pipelines & Deployment

- [Pipeline (mypy, Biome, tsc, ...)](./docs/technical/pipeline.md)

### Install

- Linux: [Docker](./docs/install/linux-docker.md)[Native](./docs/install/linux-native.md)
- MacOS: [Docker](./docs/install/mac-docker.md)[Native](./docs/install/mac-native.md)
- Windows: [Docker](./docs/install/windows-docker.md)[WSL](./docs/install/windows-wsl.md)
- [Install script](./docs/install/install-script.md)
- [Post-install instructions](./docs/install/post-install.md)

### Editor configuration

* [JetBrains (WebStorm, PyCharm, etc...)](./docs/editors/jetbrains.md)
* [VS Code](./docs/editors/vscode.md)
* [Vim/Neovim](./docs/editors/vim.md)
* [Emacs](./docs/editors/emacs.md)
52 changes: 0 additions & 52 deletions docs/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/install/windows-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
> [!WARNING]
> This guide is not complete! Feel free to submit a PR to improve it :-)
> [!NOTE]
> We do not recommend running the project this way. This is essentially running nested virtualization, which will lead
> to poor performance. Prefer running [directly in WSL](./windows-wsl.md).
# Installing on Windows (Docker in WSL)

## Install WSL
Expand Down

0 comments on commit c645157

Please sign in to comment.