Skip to content

Commit 45a0911

Browse files
committed
Update documentation and configuration: enhance .gitignore, improve LEARN.md links, add redirects in docusaurus.config.js, and update package dependencies
1 parent b91429c commit 45a0911

File tree

7 files changed

+70
-14
lines changed

7 files changed

+70
-14
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ __pycache__/
44
node_modules/
55
build/
66
docs/node_modules/
7-
docs/build/
7+
docs/build/
8+
docs/.docusaurus/

LEARN.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ Open http://127.0.0.1:5000/
5050

5151
## Concepts map
5252

53-
- Architecture overview: docs/architecture.md
54-
- Getting started: docs/getting-started.md
55-
- Configuration: docs/configuration.md
56-
- Models and database: docs/models.md, docs/database.md
57-
- Services: docs/services/web.md, docs/services/discord.md
58-
- APIs and routes: docs/api.md
59-
- Advanced topics: docs/authentication.md, docs/file-management.md, docs/vendor-integrations.md,
60-
docs/error-monitoring.md, docs/deployment.md, docs/testing.md, docs/faq.md
53+
- Architecture overview: /architecture
54+
- Getting started: /getting-started
55+
- Configuration: /configuration
56+
- Models and database: /models, /database
57+
- Services: /services/web, /services/discord
58+
- APIs and routes: /api
59+
- Advanced topics: /authentication, /file-management, /vendor-integrations,
60+
/error-monitoring, /deployment, /testing, /faq
6161

6262
For developers:
6363
- docs/developer-setup.md

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Repository: https://github.com/zaber-dev/Zeython
1111

1212
## Documentation
1313

14-
- Start here: [LEARN.md](LEARN.md)
14+
- Start here: [/project/LEARN](https://zaber-dev.github.io/Zeython/project/LEARN)
1515
- Online docs (recommended): https://zaber-dev.github.io/Zeython/
1616
- Source and site live in [`/docs`](docs/) (Docusaurus)
17-
- Developer guide: [`docs/developer-setup.md`](docs/developer-setup.md)
17+
- Developer guide: [/developer-setup](https://zaber-dev.github.io/Zeython/developer-setup)
1818

1919
## Key Features
2020

@@ -275,7 +275,7 @@ The framework now provides enterprise-level features including:
275275
- **Performance Monitoring**: Response time tracking, slow endpoint detection, and resource usage metrics
276276
- **Multi-Currency Support**: Currency-specific balance management with transaction controls
277277

278-
📖 **See [MVC_ENHANCEMENTS.md](MVC_ENHANCEMENTS.md) for comprehensive documentation and usage examples.**
278+
📖 **See [MVC Enhancements](/project/MVC_ENHANCEMENTS) for comprehensive documentation and usage examples.**
279279

280280
### Future Enhancements
281281

docs/docusaurus.config.js

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ const config = {
2323
sidebarPath: require.resolve('./sidebars.js'),
2424
routeBasePath: '/',
2525
path: '.',
26+
exclude: ['**/node_modules/**'],
2627
editUrl: 'https://github.com/zaber-dev/Zeython/edit/main/docs/'
2728
},
2829
blog: false,
@@ -40,10 +41,38 @@ const config = {
4041
path: '..',
4142
routeBasePath: 'project',
4243
sidebarPath: require.resolve('./sidebars-project.js'),
43-
include: ['README.md', 'EXAMPLES.md', 'MVC_ENHANCEMENTS.md'],
44+
include: ['README.md', 'EXAMPLES.md', 'MVC_ENHANCEMENTS.md', 'LEARN.md'],
4445
editUrl: 'https://github.com/zaber-dev/Zeython/edit/main/',
4546
},
4647
],
48+
[
49+
'@docusaurus/plugin-client-redirects',
50+
{
51+
redirects: [
52+
{ from: ['/project/docs/architecture.md', '/project/docs/architecture'], to: '/architecture' },
53+
{ from: ['/project/docs/getting-started.md', '/project/docs/getting-started'], to: '/getting-started' },
54+
{ from: ['/project/docs/configuration.md', '/project/docs/configuration'], to: '/configuration' },
55+
{ from: ['/project/docs/config-reference.md', '/project/docs/config-reference'], to: '/config-reference' },
56+
{ from: ['/project/docs/models.md', '/project/docs/models'], to: '/models' },
57+
{ from: ['/project/docs/database.md', '/project/docs/database'], to: '/database' },
58+
{ from: ['/project/docs/services/web.md', '/project/docs/services/web'], to: '/services/web' },
59+
{ from: ['/project/docs/services/discord.md', '/project/docs/services/discord'], to: '/services/discord' },
60+
{ from: ['/project/docs/api.md', '/project/docs/api'], to: '/api' },
61+
{ from: ['/project/docs/authentication.md', '/project/docs/authentication'], to: '/authentication' },
62+
{ from: ['/project/docs/file-management.md', '/project/docs/file-management'], to: '/file-management' },
63+
{ from: ['/project/docs/vendor-integrations.md', '/project/docs/vendor-integrations'], to: '/vendor-integrations' },
64+
{ from: ['/project/docs/error-monitoring.md', '/project/docs/error-monitoring'], to: '/error-monitoring' },
65+
{ from: ['/project/docs/performance.md', '/project/docs/performance'], to: '/performance' },
66+
{ from: ['/project/docs/deployment.md', '/project/docs/deployment'], to: '/deployment' },
67+
{ from: ['/project/docs/testing.md', '/project/docs/testing'], to: '/testing' },
68+
{ from: ['/project/docs/troubleshooting.md', '/project/docs/troubleshooting'], to: '/troubleshooting' },
69+
{ from: ['/project/docs/security.md', '/project/docs/security'], to: '/security' },
70+
{ from: ['/project/docs/faq.md', '/project/docs/faq'], to: '/faq' },
71+
{ from: ['/project/docs/examples.md', '/project/docs/examples'], to: '/examples' },
72+
{ from: ['/project/docs/developer-setup.md', '/project/docs/developer-setup'], to: '/developer-setup' },
73+
],
74+
},
75+
],
4776
],
4877
themeConfig:
4978
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({

docs/package-lock.json

Lines changed: 25 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"@docusaurus/core": "3.8.1",
1313
"@docusaurus/preset-classic": "3.8.1",
1414
"@docusaurus/theme-classic": "3.8.1",
15+
"@docusaurus/plugin-client-redirects": "3.8.1",
1516
"clsx": "^2.1.0",
1617
"prism-react-renderer": "^2.4.0",
1718
"react": "^18.3.1",

docs/src/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Zeython Docs
3-
slug: /
3+
slug: /home
44
---
55

66
import Link from '@docusaurus/Link';

0 commit comments

Comments
 (0)