Skip to content

Commit c331b04

Browse files
Rename docs hub repo to docs and fix site base URL.
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b873d7e commit c331b04

6 files changed

Lines changed: 24 additions & 16 deletions

File tree

CHANGELOG.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
= Changelog
22

3+
== 2026-07-31
4+
5+
* Rename hub repository to https://github.com/openshellorg/docs[docs] (local + remote), matching Dev-Centr; Antora site base is now `/docs/`. Antora hub component id remains `open-shell-org`.
6+
37
== 2026-07-30
48

59
* Assemble https://github.com/openshellorg/terminal-gui-prompts[`terminal-gui-prompts`] Antora component into the docs playbooks; list it under Orientation and help on the Ecosystem page.

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Open Shell Organization (OSO)
1+
# OpenShellOrg Docs
22

3-
The **Open Shell Organization** improves shells and CLIs through **standards, certification, and companion tooling**.
3+
Documentation hub for https://github.com/openshellorg[OpenShellOrg] — Antora site aggregating org projects, plus SOS certification packages in this monorepo.
44

55
<p align="center">
66
<img src="assets/brand/logo-mark.svg" width="160" height="160" alt="OpenShellOrg" />
@@ -27,17 +27,19 @@ SOS remains the certification/flag work in this monorepo. Structured-shell direc
2727

2828
Dev-Centr **recommends/configures** Nushell for developers; OpenShellOrg **standardizes and tools**. Keep the orgs aligned, not merged.
2929

30-
## Monorepo structure
30+
## Repository structure
3131

3232
```
33-
open-shell-org/
33+
docs/ # this repo (openshellorg/docs)
3434
├── apps/
3535
│ └── main/ # Main website (SolidStart)
36-
├── docs/ # Antora documentation (Valentus theme)
36+
├── docs/ # Antora hub component (SOS, philosophy, ecosystem)
3737
├── packages/
38-
│ ├── sos-grammar/ # @sos/grammar - SOS syntax grammar definitions
39-
│ └── sos-validator-core/ # @sos/validator-core - Core validation library
40-
├── assets/brand/ # Logo SVG/PNG (includes 256px GitHub avatar)
38+
│ ├── sos-grammar/ # @sos/grammar
39+
│ └── sos-validator-core/
40+
├── assets/brand/
41+
├── antora-playbook.yml # production (aggregates sibling repos)
42+
├── antora-playbook-local.yml
4143
└── package.json
4244
```
4345

@@ -46,7 +48,7 @@ open-shell-org/
4648
| Path | Description |
4749
|------|-------------|
4850
| `apps/main` | Organization website (SolidStart) |
49-
| `docs/` | SOS specification (Antora + Valentus 2.0.0) |
51+
| `docs/` | Hub Antora component (SOS + org pages) |
5052
| `@sos/grammar` | Grammar definitions for parsing SOS syntax |
5153
| `@sos/validator-core` | Core validation logic for SOS compliance |
5254

@@ -60,8 +62,8 @@ open-shell-org/
6062
### Installation
6163

6264
```bash
63-
git clone https://github.com/openshellorg/open-shell-org.git
64-
cd open-shell-org
65+
git clone https://github.com/openshellorg/docs.git
66+
cd docs
6567
pnpm install
6668
```
6769

@@ -74,11 +76,13 @@ pnpm build
7476

7577
# Docs (Antora)
7678
pnpm docs
79+
# or local sibling checkouts:
80+
pnpm docs:local
7781
```
7882

7983
## Documentation
8084

81-
Published docs: https://openshellorg.github.io/open-shell-org/
85+
Published docs: https://openshellorg.github.io/docs/
8286

8387
Org site: https://openshellorg.github.io/
8488

antora-playbook-local.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site:
22
title: OpenShellOrg Docs
3-
url: https://opensh.org/open-shell-org
3+
url: https://openshellorg.github.io/docs
44
start_page: open-shell-org::index.adoc
55
keys:
66
header_logo: logo.svg

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site:
22
title: OpenShellOrg Docs
3-
url: https://opensh.org/open-shell-org
3+
url: https://openshellorg.github.io/docs
44
start_page: open-shell-org::index.adoc
55
keys:
66
header_logo: logo.svg

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "open-shell-org",
2+
"name": "docs",
33
"private": true,
44
"packageManager": "pnpm@10.28.2",
55
"scripts": {

supplemental-ui/partials/footer-content.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<p class="footer-related-links">
55
<a href="https://openshellorg.github.io/">OpenShellOrg</a>
66
·
7-
<a href="https://openshellorg.github.io/open-shell-org/">OSO Docs</a>
7+
<a href="https://openshellorg.github.io/docs/">OSO Docs</a>
88
·
99
<a href="https://github.com/openshellorg">openshellorg</a>
1010
·

0 commit comments

Comments
 (0)