From b59375f695224a0674e7b2207dd859988a6edc90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nils=20Gustav=20Str=C3=A5b=C3=B8?= Date: Tue, 1 Oct 2024 15:08:54 +0200 Subject: [PATCH] add info in readme about nginx configs --- public-site/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/public-site/README.md b/public-site/README.md index 495573f..1ad1438 100644 --- a/public-site/README.md +++ b/public-site/README.md @@ -32,6 +32,8 @@ You can also run docusurus locally. All that is needed is NodeJS and NPM. In the File `docusaurus.config.ts` contains the main configuration for Docusaurus. This is where we configure the overall page layout like headers, footers, navbar, themes etc. `sidebars.ts` contains configuration for the sidebars. +Documentation folder structure: + - `/community/`: Information about the Radix community and team. - `/docs/`: General concepts (topics). - `/feature/`: List of all fratures in Radix. @@ -39,6 +41,12 @@ File `docusaurus.config.ts` contains the main configuration for Docusaurus. This - `/radix-config/`: Reference documentation for end-users. - `/start/`: Getting started guide +NGINX configuration: + +- `/proxy/server.conf`: Configuration used for production. Serves the statically built files. +- `/proxy/server.dev.conf`: Configuration used for development. Proxies requests to docusaurus backend. +- `/proxy/securityheaders`: Contains security related headers for the HTTP response. Included in both production and development configurations. + ## docusaurus This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. @@ -47,6 +55,7 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ```bash npx create-docusaurus@latest public-site classic --typescript ``` + # Credits trees by Made x Made from the Noun Project: <https://thenounproject.com/term/trees/1723897/>