Skip to content

Commit b6068b1

Browse files
docs: update Get Started documentation and navigation
- Introduce a new `index.md` file as the Get Started page, replacing `get_started.md`. - Update `mkdocs.yml` to reflect the new file structure for navigation. - Enhance the content of the Get Started section with an introduction to ArchiPy and installation guidance.
1 parent 95ce6ea commit b6068b1

3 files changed

Lines changed: 2 additions & 2 deletions

File tree

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ This section outlines the standards and practices for ArchiPy documentation.
202202

203203
- `mkdocs.yml` - Main configuration file for MkDocs
204204
- `docs/` - Markdown documentation files
205-
- `get_started.md` - Get Started page
205+
- `index.md` - Get Started page
206206
- `api_reference/` - API documentation
207207
- `examples/` - Usage examples
208208
- `assets/` - Images and other static assets
File renamed without changes.

docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ plugins:
120120

121121
# Navigation
122122
nav:
123-
- Get Started: get_started.md
123+
- Get Started: index.md
124124
- Concepts: concepts.md
125125
- Tutorials:
126126
- Overview: examples/index.md

0 commit comments

Comments
 (0)