Skip to content

Commit

Permalink
update docs structure and add "coming soon"to empty pages (#515)
Browse files Browse the repository at this point in the history
  • Loading branch information
Santonia27 authored Aug 22, 2024
1 parent 88d1537 commit 83571f1
Show file tree
Hide file tree
Showing 35 changed files with 56 additions and 28 deletions.
1 change: 1 addition & 0 deletions docs/1_introduction/terminology.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Terminology
---
Coming soon.
1 change: 1 addition & 0 deletions docs/2_installation_guide/folder_struct.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Folder Structure
---
Coming soon.
1 change: 1 addition & 0 deletions docs/2_installation_guide/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Getting started with FloodAdapt
---
Coming soon.
1 change: 1 addition & 0 deletions docs/2_installation_guide/installation.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Installation steps
---
Coming soon.
1 change: 1 addition & 0 deletions docs/2_installation_guide/software_req.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: CFRSS system requirements
---
Coming soon.
1 change: 1 addition & 0 deletions docs/2_installation_guide/system_req.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: CFRSS system requirements
---
Coming soon.
7 changes: 7 additions & 0 deletions docs/3_setup_guide/SFINCS/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "SFINCS Setup"
---

# Coming soon...

...
4 changes: 2 additions & 2 deletions docs/3_setup_guide/database.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Building the database
title: Database Setup
---

Im testing
Coming soon.
3 changes: 0 additions & 3 deletions docs/3_setup_guide/gui.qmd

This file was deleted.

3 changes: 2 additions & 1 deletion docs/3_setup_guide/risk_analysis.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Set-up for probabilistic risk analysis
title: Event Setup
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/arc_gis/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: ArcGis
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/benefits.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ filters:
- lightbox
lightbox: auto
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/compare/Compare_map.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ filters:
- lightbox
lightbox: auto
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/compare/Compare_table.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ filters:
- lightbox
lightbox: auto
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/compare/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Compare tabs
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/events/general_info.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ filters:
- lightbox
lightbox: auto
---
Coming soon.
2 changes: 1 addition & 1 deletion docs/4_user_guide/output/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Output tab
---

Hello
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/scenario_results/event_set.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Event-set (probabilistic risk) scenario output
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/scenario_results/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Scenario results
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/scenario_results/single_event.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Single-event scenario output
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/scenarios/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Scenarios
---
Coming soon.
1 change: 1 addition & 0 deletions docs/4_user_guide/strategy/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Strategies
---
Coming soon.
4 changes: 1 addition & 3 deletions docs/4_user_guide/user_interface.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: GUI features
---
To be filled in when the general features are more finalized (e.g. view and help options)

Test.
Coming soon.
1 change: 1 addition & 0 deletions docs/5_update_model/aggregation_areas.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Adding new aggregation areas
---
Coming soon.
1 change: 1 addition & 0 deletions docs/5_update_model/damage_functions.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Updating damage functions
---
Coming soon.
1 change: 1 addition & 0 deletions docs/5_update_model/dem.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Updating the DEM
---
Coming soon.
2 changes: 1 addition & 1 deletion docs/5_update_model/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Updating FloodAdapt
---

Soon to come...
Coming soon.
1 change: 1 addition & 0 deletions docs/5_update_model/objects.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Adding / updating objects in the exposure data
---
Coming soon.
1 change: 1 addition & 0 deletions docs/5_update_model/settings.qmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Updating settings for running probabilistic scenarios
---
Coming soon.

# Updating return periods

Expand Down
1 change: 1 addition & 0 deletions docs/6_demo/army_corps.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: The Army Corps has a surge-protection plan for the peninsula – what about the rest of Charleston?
---
Coming soon.
1 change: 1 addition & 0 deletions docs/6_demo/index.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: Demonstrating the use of FloodAdapt
---
Coming soon.
1 change: 1 addition & 0 deletions docs/6_demo/king_tides.qmd
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
title: King tides are already a problem – how will that look with sea level rise?
---
Coming soon.
2 changes: 1 addition & 1 deletion docs/6_demo/measures_impact.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Measures and their impact
---



Coming soon.
## Exploring measures

## Evaluating measures
Expand Down
11 changes: 7 additions & 4 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,16 @@ website:
- section: "Setup Guide"
file: 3_setup_guide/index.qmd
contents:
- "3_setup_guide/database.qmd"
- "3_setup_guide/gui.qmd"
- "3_setup_guide/risk_analysis.qmd"
- section: "Setup Delft FIAT"
- section: "SFINCS Setup"
file: "3_setup_guide/SFINCS/index.qmd"
contents:
- "3_setup_guide/SFINCS/index.qmd"
- section: "Delft FIAT Setup"
file: "3_setup_guide/Delft_Fiat/index.qmd"
contents:
- "3_setup_guide/Delft_Fiat/hydromt_fiat_gui.qmd"
- "3_setup_guide/risk_analysis.qmd"
- "3_setup_guide/database.qmd"
- section: "Updating FloodAdapt"
file: "5_update_model/index.qmd"
contents:
Expand Down
21 changes: 9 additions & 12 deletions docs/_static/theme-light.scss
Original file line number Diff line number Diff line change
Expand Up @@ -103,39 +103,36 @@ $navbar-hl: $links ;
height: 170%;
}

#quarto-sidebar-section-7 .sidebar-item:nth-child(3) {
padding-bottom: 20px;
}
#quarto-sidebar-section-7 .sidebar-item:nth-child(3) a:hover {
height: 170%;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(1) {
#quarto-sidebar-section-10 .sidebar-item:nth-child(1) {
padding-bottom: 15px;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(3) {
#quarto-sidebar-section-10 .sidebar-item:nth-child(3) {
padding-top: 15px;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(5) {
#quarto-sidebar-section-10 .sidebar-item:nth-child(5) {
padding-bottom: 15px;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(1) a:hover {
#quarto-sidebar-section-10 .sidebar-item:nth-child(1) a:hover {
width: 105%;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(2) a:hover {
#quarto-sidebar-section-10 .sidebar-item:nth-child(2) a:hover {
height: 140%;
}
#quarto-sidebar-section-9 .sidebar-item:nth-child(5) a:hover {
#quarto-sidebar-section-10 .sidebar-item:nth-child(5) a:hover {
height: 160%;
width: 105%
}
#quarto-sidebar-section-9 .sidebar-item-container {
#quarto-sidebar-section-10 .sidebar-item-container {
height: 30px !important;
}

#quarto-sidebar-section-9 .sidebar-item:first-child a:hover {
#quarto-sidebar-section-10 .sidebar-item:first-child a:hover {
width: 105%;
}
#quarto-sidebar-section-10 .sidebar-item:nth-child(1) {
#quarto-sidebar-section-11 .sidebar-item:nth-child(1) {
padding-bottom: 15px;
}

Expand Down

0 comments on commit 83571f1

Please sign in to comment.