Initial wiki structure
This commit is contained in:
41
docs/schema/hierarchy.md
Normal file
41
docs/schema/hierarchy.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Wiki Page Hierarchy & URL Structure
|
||||
|
||||
To ensure a structured and navigable wiki, all pages must follow this hierarchical pathing and categorization schema.
|
||||
|
||||
## 1. Top-Level Categories
|
||||
|
||||
| Directory | Content Type | URL Pattern |
|
||||
|-----------|--------------|-------------|
|
||||
| `ships/` | All ship hulls | `/ships/{race}/{group}/{ship_name}` |
|
||||
| `modules/`| All ship modules | `/modules/{category}/{group}/{module_name}` |
|
||||
| `mechanics/`| Game mechanics/guides | `/mechanics/{category}/{topic}` |
|
||||
| `items/` | General items (ammo, etc) | `/items/{category}/{item_name}` |
|
||||
| `skills/` | Character skills | `/skills/{category}/{skill_name}` |
|
||||
| `factions/`| NPC Factions | `/factions/{faction_name}` |
|
||||
|
||||
## 2. Detailed Pathing Examples
|
||||
|
||||
### Ships
|
||||
- **Path:** `/ships/caldari/interceptors/raptor`
|
||||
- **Breadcrumb:** Ships > Caldari > Interceptors > Raptor
|
||||
|
||||
### Modules
|
||||
- **Path:** `/modules/shield/shield-extenders/large-shield-extender-ii`
|
||||
- **Breadcrumb:** Modules > Shield > Shield Extenders > Large Shield Extender II
|
||||
|
||||
### Mechanics
|
||||
- **Path:** `/mechanics/combat/tracking-guide`
|
||||
- **Breadcrumb:** Mechanics > Combat > Tracking Guide
|
||||
|
||||
## 3. Redirect & Alias Strategy
|
||||
- **TypeID Redirects:** Every page must be aliased by its ESI TypeID (e.g., `/id/603` -> `/ships/caldari/interceptors/raptor`) to allow easy linking from external tools.
|
||||
- **Lowercase Enforcement:** All URLs must be strictly lowercase.
|
||||
- **Slugification:** Spaces replaced by hyphens, special characters removed.
|
||||
|
||||
## 4. Metadata Requirement
|
||||
Each page MUST include the following metadata in its frontmatter to support the hierarchy:
|
||||
```yaml
|
||||
path: "ships/caldari/interceptors/raptor"
|
||||
parent: "ships/caldari/interceptors"
|
||||
order: 10 # Optional: for sorting in lists
|
||||
```
|
||||
Reference in New Issue
Block a user