Skip to content

Commit 498d39c

Browse files
committed
add landing apge to docs
1 parent ed53da7 commit 498d39c

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

docs/index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
---
2+
title: Remote-Sensing-SRGAN
3+
hide:
4+
- navigation
5+
- toc
6+
---
7+
8+
# 🛰️ SRGAN for Remote Sensing
9+
10+
> Flexible super-resolution GANs for satellite imagery
11+
> *Open-source, PyTorch-Lightning-based, and ready for research.*
12+
13+
<div class="grid cards" markdown>
14+
- :rocket: **Get Started**
15+
Learn installation, configuration, and your first training run.
16+
[:material-play-circle: Getting Started](getting-started.md)
17+
18+
- :gear: **Architecture**
19+
Dive into the model design, generators, discriminators, and loss functions.
20+
[:material-cog-outline: Architecture](architecture.md)
21+
22+
- :bar_chart: **Results**
23+
See qualitative and quantitative outcomes of SRGAN models.
24+
[:material-chart-line: Results](results.md)
25+
26+
- :books: **API Reference**
27+
Detailed documentation of all Python modules and functions.
28+
[:material-code-tags: API Reference](api-reference/index.md)
29+
</div>
30+
31+
---
32+
33+
134
<img src="https://github.com/ESAOpenSR/opensr-model/blob/main/resources/opensr_logo.png?raw=true" width="250"/>
235

336
# SISR-RS-SRGAN

mkdocs.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ docs_dir: docs
1010
theme:
1111
name: material
1212
features:
13+
- navigation.tabs # <- top tabs
14+
- navigation.sections # sidebar sections
15+
- navigation.indexes # use section index pages (api-reference/index.md)
16+
- navigation.tabs.sticky
1317
- navigation.instant
1418
- navigation.sections
1519
- content.code.copy
@@ -56,10 +60,11 @@ nav:
5660
- Trainer Details: trainer-details.md
5761
- Training Guideline: training-guideline.md
5862
- Results: results.md
63+
5964
- API reference:
6065
- Overview: api-reference/index.md
6166
- Inference API: api-reference/inference.md
6267
- Training API: api-reference/training.md
6368
- Model Components: api-reference/model.md
6469
- Data Pipeline: api-reference/data.md
65-
- Utility Helpers: api-reference/utils.md
70+
- Utility Helpers: api-reference/utils.md

0 commit comments

Comments
 (0)