Skip to content

Commit 7587dd8

Browse files
authored
Merge pull request #3 from lenadoc/test-page
Update index.md
2 parents d8d08be + e4f7c9b commit 7587dd8

1 file changed

Lines changed: 78 additions & 12 deletions

File tree

docs/index.md

Lines changed: 78 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,83 @@
1-
# Welcome to MkDocs
1+
# Welcome to the SoftwareGuide Documentation
22

3-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
3+
Welcome to **SoftwareGuide**! This guide will help you navigate through creating, installing, and using your software projects effectively. Whether you're a beginner or an expert, you'll find helpful tips, notes, and detailed instructions in this documentation.
44

5-
## Commands
5+
---
66

7-
* `mkdocs new [dir-name]` - Create a new project.
8-
* `mkdocs serve` - Start the live-reloading docs server.
9-
* `mkdocs build` - Build the documentation site.
10-
* `mkdocs -h` - Print help message and exit.
7+
## Getting Started
8+
9+
To begin, explore the following sections:
10+
11+
- [Installation Guide](installation.md)
12+
- [Creating a New Project](create-project.md)
13+
- [Introduction to Software Development](introduction.md)
14+
15+
For additional resources, refer to the [Frequently Asked Questions](faq.md).
16+
17+
---
18+
19+
## Features at a Glance
20+
21+
| **Feature** | **Description** | **Relevant Section** |
22+
|-------------------------|---------------------------------------|--------------------------------|
23+
| Easy Installation | Step-by-step instructions to set up. | [Installation Guide](installation.md) |
24+
| Comprehensive Tutorials | Detailed project creation process. | [Create a New Project](create-project.md) |
25+
| Advanced Insights | In-depth analysis and tips. | [Introduction](introduction.md) |
26+
| Dynamic Versioning | Access to multiple documentation versions. | [Versioning Overview](versions.md) |
27+
28+
---
29+
30+
## Tips for Getting the Most Out of This Guide
31+
32+
> **Tip:** Bookmark this page for quick reference! Use the [Search Feature](search.md) to find topics faster.
33+
34+
- Make sure to check the **latest version** of this documentation for the most updated content.
35+
- Use cross-references to quickly jump between related sections.
36+
37+
---
38+
39+
## Note for Advanced Users
40+
41+
> **Note:**
42+
> Advanced users may want to explore our [API Documentation](api-reference.md) for a deeper dive into the software’s capabilities.
43+
44+
---
45+
46+
## Sample Table
47+
48+
Here’s a quick summary of system requirements for running SoftwareGuide:
49+
50+
| **Component** | **Minimum Requirement** | **Recommended Requirement** |
51+
|----------------------|-----------------------------|-----------------------------|
52+
| Operating System | Windows 10 / macOS 10.15 | Windows 11 / macOS 12 |
53+
| Processor | Intel i3 or equivalent | Intel i5 or better |
54+
| Memory (RAM) | 4GB | 8GB or more |
55+
| Disk Space | 1GB free | 5GB free |
56+
57+
---
58+
59+
## Quick Navigation
60+
61+
To learn more, navigate to:
62+
63+
- [How to Create a New Project](create-project.md#project-setup)
64+
- [Installation Instructions](installation.md#steps)
65+
- [Versioning Overview](versions.md#latest)
66+
67+
---
68+
69+
## Sample Code Block
70+
71+
Here’s a sample Python snippet to check your software environment:
72+
73+
```python
74+
import platform
75+
76+
def system_info():
77+
print("OS:", platform.system())
78+
print("Version:", platform.version())
79+
print("Architecture:", platform.architecture())
80+
81+
system_info()
1182

12-
## Project layout
1383

14-
mkdocs.yml # The configuration file.
15-
docs/
16-
index.md # The documentation homepage.
17-
... # Other markdown pages, images and other files.

0 commit comments

Comments
 (0)