Skip to content

Commit e9773b4

Browse files
committed
Add versioning section to documentation; update navigation structure and include logo and favicon assets
1 parent 88db4e7 commit e9773b4

File tree

4 files changed

+42
-12
lines changed

4 files changed

+42
-12
lines changed

docs/assets/favicon.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/assets/logo.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ Welcome to the Zeython docs. This site complements the README and LEARN guide wi
3131
- Service Development → service-development.md
3232
- Debugging → debugging.md
3333

34+
## Versions
35+
This site currently shows the latest documentation. Planned versions (coming soon):
36+
- main (latest)
37+
- v1.x (legacy)
38+
3439
## Migration
3540
- Migration Guide → migration.md
3641

mkdocs.yml

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,61 @@ repo_url: https://github.com/zaber-dev/Zeython
66
site_author: Md Mahedi Zaman Zaber
77
edit_uri: edit/main/docs/
88
nav:
9-
- Home: index.md
10-
- Getting Started: getting-started.md
11-
- Architecture: architecture.md
12-
- Configuration: configuration.md
13-
- Configuration Reference: config-reference.md
14-
- Models: models.md
15-
- Database: database.md
16-
- API: api.md
17-
- Examples: examples.md
9+
- Overview:
10+
- Overview: index.md
11+
- Getting Started: getting-started.md
12+
- Examples: examples.md
13+
- Guide:
14+
- Architecture: architecture.md
15+
- Configuration: configuration.md
16+
- Configuration Reference: config-reference.md
17+
- API & Routes: api.md
1818
- Services:
1919
- Web: services/web.md
2020
- Discord: services/discord.md
21+
- Models & Database:
22+
- Models: models.md
23+
- Database: database.md
2124
- Advanced:
2225
- Authentication: authentication.md
2326
- File Management: file-management.md
2427
- Vendor Integrations: vendor-integrations.md
2528
- Error Monitoring: error-monitoring.md
26-
- Deployment: deployment.md
2729
- Performance: performance.md
30+
- Deployment: deployment.md
2831
- Testing: testing.md
2932
- Troubleshooting: troubleshooting.md
3033
- Security: security.md
3134
- FAQ: faq.md
32-
- Migration: migration.md
3335
- For Developers:
3436
- Developer Setup: developer-setup.md
3537
- Coding Standards: coding-standards.md
3638
- Service Development: service-development.md
3739
- Debugging: debugging.md
40+
- Migration: migration.md
3841
theme:
3942
name: material
43+
logo: assets/logo.svg
44+
favicon: assets/favicon.svg
4045
features:
41-
- navigation.tabs
4246
- navigation.sections
47+
- navigation.expand
48+
- navigation.top
49+
- navigation.instant
50+
- toc.integrate
51+
- search.suggest
52+
- search.highlight
4353
- content.code.copy
54+
palette:
55+
- scheme: default
56+
primary: blue
57+
accent: indigo
58+
- scheme: slate
59+
primary: blue
60+
accent: indigo
61+
toggle:
62+
icon: material/weather-night
63+
name: Switch to dark mode
4464
markdown_extensions:
4565
- admonition
4666
- codehilite
@@ -50,5 +70,8 @@ extra:
5070
social:
5171
- icon: fontawesome/brands/github
5272
link: https://github.com/zaber-dev/Zeython
73+
copyright: "© {year} Md Mahedi Zaman Zaber"
5374
plugins:
5475
- search
76+
- tags
77+
- social

0 commit comments

Comments
 (0)