Skip to content

Commit 3cb273e

Browse files
raghavyuvaraghavyuva
authored
Merge pull request #575 from raghavyuva/docs/simplify-docs
docs: update documentation to keep it simple and user friendly
1 parent 53ef629 commit 3cb273e

28 files changed

+764
-5337
lines changed

‎docs/.vitepress/config.mts‎

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,14 @@ export default withMermaid(
6363
items: [
6464
{ text: "Introduction", link: "/introduction/index.md" },
6565
{ text: "Installation", link: "/install/index.md" },
66-
{ text: "Architecture", link: "/architecture/index.md" },
66+
{ text: "Roadmap", link: "https://roadmap.nixopus.com" },
6767
{ text: "Preferences", link: "/preferences/index.md" }
6868
]
6969
},
7070
{
7171
text: 'Features',
7272
items: [
73+
{ text: "Extensions", link: "/extensions/index.md" },
7374
{ text: "Hosting Projects", link: "/self-host/index.md" },
7475
{ text: 'Terminal', link: '/terminal/index.md' },
7576
{ text: "File Manager", link: "/file-manager/index.md" },
@@ -82,24 +83,7 @@ export default withMermaid(
8283
{ text: 'Overview', link: '/cli/index.md' },
8384
{ text: 'Installation', link: '/cli/installation.md' },
8485
{ text: 'Configuration', link: '/cli/config.md' },
85-
{
86-
text: 'Commands',
87-
collapsed: true,
88-
items: [
89-
{ text: 'preflight', link: '/cli/commands/preflight.md' },
90-
{ text: 'conflict', link: '/cli/commands/conflict.md' },
91-
{ text: 'install', link: '/cli/commands/install.md' },
92-
{ text: 'uninstall', link: '/cli/commands/uninstall.md' },
93-
{ text: 'service', link: '/cli/commands/service.md' },
94-
{ text: 'conf', link: '/cli/commands/conf.md' },
95-
{ text: 'proxy', link: '/cli/commands/proxy.md' },
96-
{ text: 'clone', link: '/cli/commands/clone.md' },
97-
{ text: 'version', link: '/cli/commands/version.md' },
98-
{ text: 'test', link: '/cli/commands/test.md' }
99-
]
100-
},
101-
{ text: 'Reference', link: '/cli/cli-reference.md' },
102-
{ text: 'Development', link: '/cli/development.md' }
86+
{ text: 'Reference', link: '/cli/cli-reference.md' }
10387
]
10488
},
10589
{
@@ -111,27 +95,14 @@ export default withMermaid(
11195
{
11296
text: 'Development',
11397
items: [
114-
{
115-
text: 'Contribution',
116-
items: [
117-
{ text: 'Overview', link: '/contributing/index.md' },
118-
{ text: 'Backend', link: '/contributing/backend.md' },
119-
{ text: 'Frontend', link: '/contributing/frontend.md' },
120-
{ text: 'Documentation', link: '/contributing/documentation.md' },
121-
{ text: 'Docker', link: '/contributing/docker.md' },
122-
{ text: 'Self Hosting', link: '/contributing/self-hosting.md' },
123-
{ text: 'Fixtures', link: '/contributing/fixtures.md' }
124-
]
125-
},
126-
{
127-
text: 'Database',
128-
items: [
129-
{ text: 'Migrations Guide', link: '/migrations/index.md' },
130-
{ text: 'Quick Reference', link: '/migrations/quick-reference.md' },
131-
{ text: 'Templates', link: '/migrations/templates.md' }
132-
]
133-
},
98+
{ text: 'Development Guide', link: '/contributing/index.md' },
99+
{ text: "Workflows", link: "/workflows/index.md" },
134100
{ text: "Code of Conduct", link: "/code-of-conduct/index.md" },
101+
]
102+
},
103+
{
104+
text: "Policy",
105+
items: [
135106
{ text: "Changelogs", link: "https://github.com/raghavyuva/nixopus/releases" },
136107
{ text: "License", link: "/license/index.md" },
137108
{ text: "Privacy Policy", link: "/privacy-policy/index.md" },

‎docs/architecture/index.md‎

Lines changed: 0 additions & 169 deletions
This file was deleted.

‎docs/cli/cli-reference.md‎

Lines changed: 83 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ $ nixopus [OPTIONS] COMMAND [ARGS]...
2323
* `proxy`: Manage Nixopus proxy (Caddy) configuration
2424
* `install`: Install Nixopus
2525
* `uninstall`: Uninstall Nixopus
26+
* `update`: Update Nixopus
2627
* `version`: Show version information
2728

2829
## `nixopus preflight`
@@ -139,7 +140,7 @@ $ nixopus conflict [OPTIONS] COMMAND [ARGS]...
139140

140141
**Options**:
141142

142-
* `-c, --config-file TEXT`: Path to configuration file [default: helpers/config.prod.yaml]
143+
* `-c, --config-file TEXT`: Path to configuration file (defaults to built-in config)
143144
* `-t, --timeout INTEGER`: Timeout for tool checks in seconds [default: 5]
144145
* `-v, --verbose`: Verbose output
145146
* `-o, --output TEXT`: Output format (text/json) [default: text]
@@ -371,7 +372,7 @@ $ nixopus proxy load [OPTIONS]
371372

372373
**Options**:
373374

374-
* `-p, --proxy-port INTEGER`: Caddy admin port [default: 2019]
375+
* `-p, --proxy-port INTEGER`: Caddy admin port [default: ${CADDY_ADMIN_PORT:-2019}]
375376
* `-v, --verbose`: Verbose output
376377
* `-o, --output TEXT`: Output format: text, json [default: text]
377378
* `--dry-run`: Dry run
@@ -391,7 +392,7 @@ $ nixopus proxy status [OPTIONS]
391392

392393
**Options**:
393394

394-
* `-p, --proxy-port INTEGER`: Caddy admin port [default: 2019]
395+
* `-p, --proxy-port INTEGER`: Caddy admin port [default: ${CADDY_ADMIN_PORT:-2019}]
395396
* `-v, --verbose`: Verbose output
396397
* `-o, --output TEXT`: Output format: text, json [default: text]
397398
* `--dry-run`: Dry run
@@ -410,7 +411,7 @@ $ nixopus proxy stop [OPTIONS]
410411

411412
**Options**:
412413

413-
* `-p, --proxy-port INTEGER`: Caddy admin port [default: 2019]
414+
* `-p, --proxy-port INTEGER`: Caddy admin port [default: ${CADDY_ADMIN_PORT:-2019}]
414415
* `-v, --verbose`: Verbose output
415416
* `-o, --output TEXT`: Output format: text, json [default: text]
416417
* `--dry-run`: Dry run
@@ -434,15 +435,59 @@ $ nixopus install [OPTIONS] COMMAND [ARGS]...
434435
* `-f, --force`: Replace files if they already exist
435436
* `-d, --dry-run`: See what would happen, but don't make changes
436437
* `-c, --config-file TEXT`: Path to custom config file (defaults to built-in config)
438+
* `-D, --development`: Use development workflow (local setup, dev compose, dev env)
439+
* `--dev-path TEXT`: Installation directory for development workflow (defaults to current directory)
437440
* `-ad, --api-domain TEXT`: The domain where the nixopus api will be accessible (e.g. api.nixopus.com), if not provided you can use the ip address of the server and the port (e.g. 192.168.1.100:8443)
438441
* `-vd, --view-domain TEXT`: The domain where the nixopus view will be accessible (e.g. nixopus.com), if not provided you can use the ip address of the server and the port (e.g. 192.168.1.100:80)
442+
* `-ip, --host-ip TEXT`: The IP address of the server to use when no domains are provided (e.g. 10.0.0.154 or 192.168.1.100). If not provided, the public IP will be automatically detected.
443+
* `--api-port INTEGER`: Port for the API service (default: 8443 for production, 8080 for development)
444+
* `--view-port INTEGER`: Port for the View/Frontend service (default: 7443 for production, 3000 for development)
445+
* `--db-port INTEGER`: Port for the PostgreSQL database (default: 5432)
446+
* `--redis-port INTEGER`: Port for the Redis service (default: 6379)
447+
* `--caddy-admin-port INTEGER`: Port for Caddy admin API (default: 2019)
448+
* `--caddy-http-port INTEGER`: Port for Caddy HTTP traffic (default: 80)
449+
* `--caddy-https-port INTEGER`: Port for Caddy HTTPS traffic (default: 443)
450+
* `--supertokens-port INTEGER`: Port for SuperTokens service (default: 3567)
451+
* `-r, --repo TEXT`: GitHub repository URL to clone (defaults to config value)
452+
* `-b, --branch TEXT`: Git branch to clone (defaults to config value)
439453
* `--help`: Show this message and exit.
440454

441455
**Commands**:
442456

457+
* `development`: Install Nixopus for local development in...
443458
* `ssh`: Generate an SSH key pair with proper...
444459
* `deps`: Install dependencies
445460

461+
### `nixopus install development`
462+
463+
Install Nixopus for local development in specified or current directory
464+
465+
**Usage**:
466+
467+
```console
468+
$ nixopus install development [OPTIONS]
469+
```
470+
471+
**Options**:
472+
473+
* `-p, --path TEXT`: Installation directory (defaults to current directory)
474+
* `-v, --verbose`: Show more details while installing
475+
* `-t, --timeout INTEGER`: How long to wait for each step (in seconds) [default: 1800]
476+
* `-f, --force`: Replace files if they already exist
477+
* `-d, --dry-run`: See what would happen, but don't make changes
478+
* `-c, --config-file TEXT`: Path to custom config file (defaults to config.dev.yaml)
479+
* `-r, --repo TEXT`: GitHub repository URL to clone (defaults to config value)
480+
* `-b, --branch TEXT`: Git branch to clone (defaults to config value)
481+
* `--api-port INTEGER`: Port for the API service (default: 8080)
482+
* `--view-port INTEGER`: Port for the View/Frontend service (default: 3000)
483+
* `--db-port INTEGER`: Port for the PostgreSQL database (default: 5432)
484+
* `--redis-port INTEGER`: Port for the Redis service (default: 6379)
485+
* `--caddy-admin-port INTEGER`: Port for Caddy admin API (default: 2019)
486+
* `--caddy-http-port INTEGER`: Port for Caddy HTTP traffic (default: 80)
487+
* `--caddy-https-port INTEGER`: Port for Caddy HTTPS traffic (default: 443)
488+
* `--supertokens-port INTEGER`: Port for SuperTokens service (default: 3567)
489+
* `--help`: Show this message and exit.
490+
446491
### `nixopus install ssh`
447492

448493
Generate an SSH key pair with proper permissions and optional authorized_keys integration
@@ -505,6 +550,40 @@ $ nixopus uninstall [OPTIONS] COMMAND [ARGS]...
505550
* `-f, --force`: Remove files without confirmation prompts
506551
* `--help`: Show this message and exit.
507552

553+
## `nixopus update`
554+
555+
Update Nixopus
556+
557+
**Usage**:
558+
559+
```console
560+
$ nixopus update [OPTIONS] COMMAND [ARGS]...
561+
```
562+
563+
**Options**:
564+
565+
* `-v, --verbose`: Show more details while updating
566+
* `--help`: Show this message and exit.
567+
568+
**Commands**:
569+
570+
* `cli`: Update CLI tool
571+
572+
### `nixopus update cli`
573+
574+
Update CLI tool
575+
576+
**Usage**:
577+
578+
```console
579+
$ nixopus update cli [OPTIONS]
580+
```
581+
582+
**Options**:
583+
584+
* `-v, --verbose`: Show more details while updating
585+
* `--help`: Show this message and exit.
586+
508587
## `nixopus version`
509588

510589
Show version information

0 commit comments

Comments
 (0)