Skip to content

Commit 2b19c03

Browse files
committed
Improve user journey navigation across the site
- Fix 4 broken internal links (missing /stepss-docs base path) - Update landing page: replace developer-heavy quick links with Model Reference and Test Systems; change secondary CTA to Browse Examples - Add 'Next Steps' cross-navigation to 10 key pages guiding users through the natural flow: Overview → Install → Quick Start → File Formats → Network → PFC → Reference Frames → Dynamic Models → Disturbances → Solver → PyRAMSES → Test Systems - Merge thin 'Analysis' sidebar section into 'Dynamic Simulation' (eigenanalysis is part of the simulation workflow)
1 parent 7a50b4b commit 2b19c03

File tree

14 files changed

+65
-13
lines changed

14 files changed

+65
-13
lines changed

src/content/docs/developer/user-models.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,3 +406,9 @@ After writing a model file, CODEGEN translates it into Fortran 2003 code. The wo
406406
For compilation details, see [URAMSES](/stepss-docs/developer/uramses/).
407407

408408
See the [CODEGEN Blocks Library](/stepss-docs/developer/codegen-library/) for the available modelling blocks.
409+
410+
## Next Steps
411+
412+
- [CODEGEN Blocks Library](/stepss-docs/developer/codegen-library/) — Reference for all modeling blocks
413+
- [CODEGEN Model Examples](/stepss-docs/developer/codegen-examples/) — Complete model files for each type
414+
- [URAMSES](/stepss-docs/developer/uramses/) — Compile and link custom models with RAMSES

src/content/docs/getting-started/overview.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,8 @@ See the [Quick Start](/stepss-docs/getting-started/quickstart/) for details on e
105105
| **Command-line executables** | Windows and Linux (ramses, pfc) |
106106
| **CODEGEN compilation** | Visual Studio 2022 + Intel oneAPI Fortran |
107107
| **Free version limits** | 1000 buses max, 2 OpenMP cores |
108+
109+
## Next Steps
110+
111+
- [Installation](/stepss-docs/getting-started/installation/) — Set up STEPSS on your system
112+
- [Quick Start](/stepss-docs/getting-started/quickstart/) — Run your first simulation

src/content/docs/index.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ hero:
1111
link: /stepss-docs/getting-started/overview/
1212
icon: right-arrow
1313
variant: primary
14-
- text: PyRAMSES API
15-
link: /stepss-docs/pyramses/api-reference/
14+
- text: Browse Examples
15+
link: /stepss-docs/pyramses/examples/
1616
icon: right-arrow
1717
---
1818

19-
import { Card, CardGrid } from '@astrojs/starlight/components';
19+
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
2020

2121
## Core Modules
2222

@@ -31,7 +31,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
3131
Translates user-defined models into Fortran 2003 code for compilation and linking with RAMSES.
3232
</Card>
3333
<Card title="PyRAMSES — Python Interface" icon="seti:python">
34-
Modern Python API for scripting simulations, extracting results, and integrating with the scientific Python ecosystem.
34+
Python API for scripting simulations, extracting results, and integrating with the scientific Python ecosystem.
3535
</Card>
3636
</CardGrid>
3737

@@ -44,10 +44,10 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
4444
<Card title="Quick Start" icon="open-book">
4545
[Run your first simulation →](/stepss-docs/getting-started/quickstart/)
4646
</Card>
47-
<Card title="User-Defined Models" icon="setting">
48-
[Create custom models with CODEGEN ](/stepss-docs/developer/user-models/)
47+
<Card title="Model Reference" icon="list-format">
48+
[Browse available models →](/stepss-docs/models/ieee-exciters/)
4949
</Card>
50-
<Card title="URAMSES" icon="puzzle">
51-
[Compile and link Fortran models ](/stepss-docs/developer/uramses/)
50+
<Card title="Test Systems" icon="star">
51+
[Nordic and 5-bus benchmarks ](/stepss-docs/test-systems/nordic/)
5252
</Card>
5353
</CardGrid>

src/content/docs/pyramses/api-reference.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -813,3 +813,8 @@ pyramses.curplot([
813813
ext.getSync('g3').S,
814814
])
815815
```
816+
817+
## Next Steps
818+
819+
- [Examples](/stepss-docs/pyramses/examples/) — Practical simulation examples and workflows
820+
- [Test Systems](/stepss-docs/test-systems/nordic/) — Ready-to-run benchmark systems

src/content/docs/pyramses/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ ram.addDisturb(100.0, 'BREAKER SYNC_MACH g7 0')
103103
ram.contSim(ram.getInfTime())
104104
```
105105

106-
For full disturbance syntax, see the [disturbances reference](/pyramses/disturbances).
106+
For full disturbance syntax, see the [Disturbances reference](/stepss-docs/user-guide/disturbances/).
107107

108108
## Plotting Results
109109

src/content/docs/pyramses/installation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,5 @@ Gnuplot must be in the system PATH. You can check availability with `pyramses.__
7474

7575
## Next Steps
7676

77-
- [API Reference](/pyramses/api-reference/) — Full API documentation
78-
- [Examples](/pyramses/examples/) — Practical usage examples
77+
- [API Reference](/stepss-docs/pyramses/api-reference/) — Full API documentation
78+
- [Examples](/stepss-docs/pyramses/examples/) — Practical usage examples

src/content/docs/pyramses/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ PyRAMSES supports both Windows and Linux operating systems. Pre-compiled RAMSES
3131

3232
## Further Reading
3333

34-
- [API Reference](/pyramses/api-reference/) — Detailed documentation for `cfg`, `sim`, and `extractor`
35-
- [Examples](/pyramses/examples/) — Practical simulation examples and notebooks
34+
- [API Reference](/stepss-docs/pyramses/api-reference/) — Detailed documentation for `cfg`, `sim`, and `extractor`
35+
- [Examples](/stepss-docs/pyramses/examples/) — Practical simulation examples and notebooks
3636

3737
## Repository
3838

src/content/docs/user-guide/disturbances.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,3 +188,8 @@ Takes a snapshot and exports the load flow at a specific time:
188188
```
189189
time(s) LFRESV 'name_of_filename'
190190
```
191+
192+
## Next Steps
193+
194+
- [Solver Settings](/stepss-docs/user-guide/solver-settings/) — Configure time steps, tolerances, and parallelism
195+
- [PyRAMSES Examples](/stepss-docs/pyramses/examples/) — See complete simulation workflows in Python

src/content/docs/user-guide/dynamic-models.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,9 @@ DCTL SIM_MINMAXVOLT CTRL_Name VMAX(pu) VMIN(pu) DEADTIME(s) Stop_Simulation(T/F)
159159
```
160160
DCTL SIM_MINMAXSPEED CTRL_Name MAX_SPEED(pu) MIN_SPEED(pu) DEADTIME(s) Stop_Simulation(T/F) ;
161161
```
162+
163+
## Next Steps
164+
165+
- [Disturbances](/stepss-docs/user-guide/disturbances/) — Define faults, trips, and parameter changes
166+
- [Solver Settings](/stepss-docs/user-guide/solver-settings/) — Configure the numerical solver
167+
- [Model Reference](/stepss-docs/models/ieee-exciters/) — Browse available exciter, governor, and injector models

src/content/docs/user-guide/file-formats.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,8 @@ A typical organization:
8080
- One file for simulation control parameters
8181

8282
These files can be listed in any order in the command file.
83+
84+
## Next Steps
85+
86+
- [Network Modeling](/stepss-docs/user-guide/network/) — Define buses, lines, transformers, and shunts
87+
- [Power Flow (PFC)](/stepss-docs/user-guide/pfc/) — Set up and run power flow computations

0 commit comments

Comments
 (0)