Skip to content

Dev #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 15, 2025
Merged

Dev #106

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 22 additions & 30 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// docs/.vitepress/config.js
import { defineConfig } from 'vitepress'

export default defineConfig({
Expand Down Expand Up @@ -31,8 +30,6 @@ export default defineConfig({

nav: [
{ text: 'Guide', link: '/guide/getting-started' },
{ text: 'Websockets', link: '/websockets/index' },
{ text: 'OpenAPI', link: '/openapi/index' },
{ text: 'API Reference', link: '/api/application' },
{ text: 'Team', link: 'team' },
],
Expand All @@ -52,7 +49,6 @@ export default defineConfig({
{
text: 'Core Concepts',
collapsed: false,

items: [
{ text: 'Routing', link: '/guide/routing' },
{ text: 'Handlers', link: '/guide/handlers' },
Expand Down Expand Up @@ -87,44 +83,40 @@ export default defineConfig({
{ text: 'Static Files', link: '/guide/static-files' },
{ text: 'File Upload', link: '/guide/file-upload' },
{ text: 'Cors', link: '/guide/cors' },
{ text : "File Router", link: '/guide/file-router' },
{ text: 'File Router', link: '/guide/file-router' },
]
},
],

'/architecture/': [
{
text: 'Architecture',
text: 'Websockets',
collapsed: false,
items: [
{ text: 'Async Python', link: '/architecture/async-python' },
{ text: 'Asgi', link: '/architecture/asgi' },
{ text: 'Overview', link: '/guide/websockets/index' },
{ text: 'Channels', link: '/guide/websockets/channels' },
{ text: 'Groups', link: '/guide/websockets/groups' },
{ text: 'Events', link: '/guide/websockets/events' },
{ text: 'Consumer', link: '/guide/websockets/consumer' },
]
}
],

'/websockets/': [
},
{
text: 'Websockets',
text: 'OpenAPI',
collapsed: false,
items: [
{ text: 'Overview', link: '/websockets/index' },
{ text: 'Channels', link: '/websockets/channels' },
{ text: 'Groups', link: '/websockets/groups' },
{ text: 'Events', link: '/websockets/events' },
{ text: 'Consumer', link: '/websockets/consumer' },
{ text: 'Overview', link: '/guide/openapi/index' },
{ text: 'Response Models with Pydantic', link: '/guide/openapi/response-models' },
{ text: 'Request Schemas', link: '/guide/openapi/request-schemas' },
{ text: 'Request Parameters', link: '/guide/openapi/request-parameters' },
{ text: 'Customizing OpenAPI Config', link: '/guide/openapi/customizing-openapi-configuration' },
{ text: 'Authentication Docs', link: '/guide/openapi/authentication-documentation' },
]
}
],

'/openapi/': [
'/architecture/': [
{
text: 'OpenAPI',
text: 'Architecture',
items: [
{ text: 'Overview', link: '/openapi/index' },
{ text: 'Response Models with Pydantic', link: '/openapi/response-models' },
{ text: 'Request Schemas', link: '/openapi/request-schemas' },
{ text: 'Request Parameters', link: '/openapi/request-parameters' },
{ text: 'Customizing OpenAPI Config', link: '/openapi/customizing-openapi-configuration' },
{ text: 'Authentication Docs', link: '/openapi/authentication-documentation' },
{ text: 'Async Python', link: '/architecture/async-python' },
{ text: 'Asgi', link: '/architecture/asgi' },
]
}
],
Expand All @@ -140,7 +132,7 @@ export default defineConfig({
{ text: 'Websocket', link: '/api/websockets' },
]
}
]
],
}
},

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions docs/openapi/index.md → docs/guide/openapi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ async def get_root(req, res):
return res.json({"message": "Hello World"})
```

<img src="/openapi/basic-config.png">
<img src="./basic-config.png">


## Adding Description
Expand All @@ -34,4 +34,4 @@ async def get_root(req, res):
return res.json({"message": "Hello World"})
```

<img src="/openapi/description.png">
<img src=./description.png">
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ include = ["nexios/py.typed"]
[tool.poetry]
name = "nexios"
version = "2.4.1"
description = "Nexios is a modern, high-performance ASGI web framework for Python with multi-server support."
description = "Nexios is a modern, high-performance ASGI web framework for Python with multi-server support with zero overhead."
authors = ["Chidebele Dunamis <[email protected]>"]
license = "MIT"
homepage = "https://github.com/nexios-labs/nexios"
Expand Down