From 81517825d611c2f822bf8a0b05876aa1da3a876b Mon Sep 17 00:00:00 2001 From: robines Date: Fri, 15 Nov 2024 21:24:03 +0100 Subject: [PATCH 1/2] Move documentation overview to main README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++-- docs/README.md | 52 -------------------------------------------------- 2 files changed, 50 insertions(+), 54 deletions(-) delete mode 100644 docs/README.md diff --git a/README.md b/README.md index e24335d94..949710e1c 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 6c13d881c..000000000 --- a/docs/README.md +++ /dev/null @@ -1,52 +0,0 @@ -[**← Back: Samfundet4**](../) - -# Documentation Overview - -> [!TIP] -> If you're new, start by going through the [Introduction to Samfundet4](./introduction.md) guide. - -## Frontend - -- [Creating react components (conventions)](./technical/frontend/components.md) -- [Forms and schemas](./technical/frontend/forms.md) - - [*Deprecated: SamfForm*](./technical/frontend/samfform.md) -- [Cypress Setup Documentation](./technical/frontend/cypress.md) -- [Data fetching and State management](./technical/frontend/data-fetching.md) - -## Backend - -- [🌐 API documentation](./api-docs.md) -- [Billig (payment system)](./technical/backend/billig.md) -- [Seed scripts](./technical/backend/seed.md) -- [Role system](./technical/backend/rolesystem.md) - -## Other - -- [Automatic Interview Scheduling](./intervew-scheduling.md) - -## Workflow - -- [Work Methodology](./work-methodology.md) - - How to contribute to the project -- [Useful Commands](./useful-commands.md) -- [Useful Docker aliases](./docker-project-specific-commands.md) -- [Common error messages](./common-errors.md) - -## Pipelines & Deployment - -- [Pipeline (mypy, Biome, tsc, ...)](./technical/pipeline.md) - -## Install - -- Linux: [Docker](./install/linux-docker.md) – [Native](./install/linux-native.md) -- MacOS: [Docker](./install/mac-docker.md) – [Native](./install/mac-native.md) -- Windows: [Docker](./install/windows-docker.md) – [WSL](./install/windows-wsl.md) -- [Install script](./install/install-script.md) -- [Post-install instructions](./install/post-install.md) - -## Editor configuration - -* [JetBrains (WebStorm, PyCharm, etc...)](./editors/jetbrains.md) -* [VS Code](./editors/vscode.md) -* [Vim/Neovim](./editors/vim.md) -* [Emacs](./editors/emacs.md) From e2193f2444dc371981a579f3d826394dd0386510 Mon Sep 17 00:00:00 2001 From: robines Date: Fri, 15 Nov 2024 21:24:37 +0100 Subject: [PATCH 2/2] Remove incorrect note --- docs/install/windows-docker.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/install/windows-docker.md b/docs/install/windows-docker.md index 14347c924..aa44d4c91 100644 --- a/docs/install/windows-docker.md +++ b/docs/install/windows-docker.md @@ -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