Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add info in readme about nginx configs #399

Merged
merged 1 commit into from
Oct 2, 2024
Merged

add info in readme about nginx configs #399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions public-site/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,21 @@ 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.
- `/guides/`: User-friendly, conversational guides on how to achieve specific objectives.
- `/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.
Expand All @@ -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/>
Expand Down