DOCUMENTATION QUICK REFERENCE - nself-org/cli GitHub Wiki
For: nself contributors and maintainers Purpose: Fast lookup of documentation standards
| Context | Format | Example |
|---|---|---|
| Code/Commands | nself |
nself start |
| Titles/Branding | ɳSelf |
# ɳSelf Documentation |
| Environment Vars | NSELF_* |
NSELF_VERSION=0.9.8 |
Tagline: "The complete self-hosted backend platform"
-
Current:
0.9.8(check/src/VERSION) -
In prose:
nself v0.9.9 -
In badges:
version-0.9.9-blue -
In links:
[Release Notes](releases/v0.9.8.md)
nself <command> <subcommand> [OPTIONS] [ARGUMENTS]
# Examples:
nself db migrate up
nself tenant create <tenant-name> --slug <slug>Rules:
- Command:
nself(lowercase only) - Subcommands:
lowercase - Flags:
--kebab-case
| Type | Format | Example |
|---|---|---|
| Commands | <kebab-case> |
<project-name> |
| Env Vars | UPPERCASE |
PROJECT_NAME |
| Examples | Concrete |
myapp, acme
|
Always use language identifier:
```bash
nself start
```
```sql
SELECT * FROM users;
```
```typescript
const user: User = { ... };
```Common identifiers: bash, sql, typescript, javascript, python, json, yaml, dbml
Use sentence case:
✅ # Database workflow guide
✅ ## Creating your first migration
❌ # Database Workflow Guide
❌ ## Creating Your First MigrationExceptions: Proper nouns (PostgreSQL, Docker, GitHub)
Use relative paths:
✅ [Quick Start](getting-started/Quick-Start.md)
✅ [Commands](commands/README.md)
❌ [Quick Start](getting-started/Quick-Start.md)
❌ [Quick Start](https://github.com/.../docs/...)| Type | Use |
|---|---|
| Project | myapp |
| Domain | example.com |
[email protected] |
|
| Tenant |
acme, Acme Corp
|
| Database | myapp_db |
Avoid: foo, bar, test123, asdf
> **v0.9.8:** Brief note. > **Warning**: This is destructive.# Start all services
nself start
# Check status
nself status- Code blocks have language identifiers
- Links are relative paths
- Version is current (0.9.9)
- Brand name is
nselfin code - Placeholders use
<kebab-case> - Headers use sentence case
- Examples use standard names
- STYLE-GUIDE.md - Full standards
- CONSISTENCY-AUDIT-REPORT.md - Analysis
- CONSISTENCY-FIX-GUIDE.md - Fix scripts
Keep this handy when writing docs!