feat: Add documentation files including Code of Conduct, Contributing guidelines, and Security policy; update Markdown linting configuration and scripts

This commit is contained in:
HueByte
2026-02-19 09:53:06 +01:00
parent 653f25b70b
commit ff9c264f4b
17 changed files with 305 additions and 21 deletions
+10
View File
@@ -0,0 +1,10 @@
# Client Articles
Articles related to the EchoHub TUI client built with Terminal.Gui v2.
## Topics
- Terminal.Gui v2 patterns and conventions
- Theme system and customization
- Command system reference
- Configuration management
+2
View File
@@ -0,0 +1,2 @@
- name: Overview
href: index.md
+9
View File
@@ -0,0 +1,9 @@
# Core Articles
Articles related to the EchoHub.Core shared library.
## Topics
- Data models and DTOs
- SignalR contract interface
- Validation constants and shared rules
+2
View File
@@ -0,0 +1,2 @@
- name: Overview
href: index.md
+17
View File
@@ -0,0 +1,17 @@
# API Reference
Browse the generated API documentation for each EchoHub project.
## Projects
### [Client](client/EchoHub.Client.yml)
Terminal.Gui v2 TUI application -- UI components, services, themes, and configuration.
### [Core](core/EchoHub.Core.Constants.yml)
Shared library -- DTOs, models, constants, and the SignalR client contract.
### [Server](server/EchoHub.Server.Controllers.yml)
ASP.NET Core server -- controllers, hubs, authentication, and data access.
+11
View File
@@ -0,0 +1,11 @@
# Server Articles
Articles related to the EchoHub server built with ASP.NET Core.
## Topics
- Authentication and JWT tokens
- SignalR hub and real-time messaging
- File upload and validation
- Rate limiting configuration
- Database schema and migrations
+2
View File
@@ -0,0 +1,2 @@
- name: Overview
href: index.md
+18
View File
@@ -0,0 +1,18 @@
- name: Client
items:
- name: API Reference
href: ../_api_meta/client/toc.yml
- name: Articles
href: client-articles/
- name: Core
items:
- name: API Reference
href: ../_api_meta/core/toc.yml
- name: Articles
href: core-articles/
- name: Server
items:
- name: API Reference
href: ../_api_meta/server/toc.yml
- name: Articles
href: server-articles/
+22 -4
View File
@@ -8,7 +8,7 @@
"files": ["EchoHub.Core.dll"]
}
],
"dest": "api/core",
"dest": "_api_meta/core",
"filter": "filterConfig.yml"
},
{
@@ -18,7 +18,7 @@
"files": ["EchoHub.Server.dll"]
}
],
"dest": "api/server",
"dest": "_api_meta/server",
"filter": "filterConfig.yml"
},
{
@@ -28,7 +28,7 @@
"files": ["EchoHub.Client.dll"]
}
],
"dest": "api/client",
"dest": "_api_meta/client",
"filter": "filterConfig.yml"
}
],
@@ -36,7 +36,25 @@
"content": [
{
"files": ["**/*.{md,yml}"],
"exclude": ["_site/**", "_temp/**"]
"exclude": ["_site/**", "_api_meta/**"]
},
{
"src": "_api_meta/core",
"dest": "api/core",
"files": ["*.yml", ".manifest"],
"exclude": ["toc.yml"]
},
{
"src": "_api_meta/server",
"dest": "api/server",
"files": ["*.yml", ".manifest"],
"exclude": ["toc.yml"]
},
{
"src": "_api_meta/client",
"dest": "api/client",
"files": ["*.yml", ".manifest"],
"exclude": ["toc.yml"]
}
],
"resource": [
+1 -1
View File
@@ -1,4 +1,4 @@
<svg width="800" height="800" viewBox="0 0 1000 1000" xmlns="http://www.w3.org/2000/svg">
<svg width="32" height="32" viewBox="0 0 1000 1000" xmlns="http://www.w3.org/2000/svg">
<g stroke="#E6C06E" stroke-width="28" fill="none" stroke-linecap="round" stroke-linejoin="round">
<circle cx="500" cy="500" r="420" />
<circle cx="500" cy="500" r="180" />

Before

Width:  |  Height:  |  Size: 592 B

After

Width:  |  Height:  |  Size: 590 B