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

chore(docs): rename architecture to how-it-works. #112

Merged
merged 1 commit into from
Jun 5, 2024
Merged

chore(docs): rename architecture to how-it-works. #112

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ nav:
- 'sso/google.md'
- 'Development Guide':
- 'Local Development': 'dev-guide/local.md'
- 'Architecture': 'dev-guide/architecture.md'
- 'How it works': 'dev-guide/how-it-works.md'
- 'Contributing': 'dev-guide/contributing.md'

plugins:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/dev-guide/architecture.md → docs/src/dev-guide/how-it-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Nesis Architecture
The Nessus project is divided into five components.
# How Nesis Works
The Nesis project is divided into five components.

1. Frontend - This contains the ReactJS frontend and Node Express server (aka frontend-backend).
2. API Backend - This is the backend API responsible for handling;
Expand Down
2 changes: 1 addition & 1 deletion docs/src/dev-guide/local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Local Development Guide

This guide walks you through how to start developing Nesis on your local workstation. You can
get an overview of the components that make up Nesis and its architecture [here](./architecture.md).
get an overview of the components that make up Nesis and its architecture [here](./how-it-works.md).

## Prerequisites
1. We use docker and docker-compose to support our development process. If you don't have docker installed
Expand Down