Skip to content

Commit 2dd8429

Browse files
authored
docs: Update references to the vendored UI (#887)
AGENTS.md and the contributor overview still described the ui/ directory as a git submodule of documentation-ui; it is part of this repository.
1 parent 51e89fe commit 2dd8429

2 files changed

Lines changed: 4 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This file helps AI coding agents (and humans) understand how to work with this r
66

77
This is the **Stackable Documentation** site, built with [Antora](https://antora.org/).
88
It aggregates AsciiDoc content from this repo plus ~18 operator repos from the `stackabletech` GitHub org.
9-
The UI comes from a git submodule in `ui/` (the [documentation-ui](https://github.com/stackabletech/documentation-ui) repo).
9+
The UI lives in the `ui/` directory and is bundled during the build.
1010

1111
## Prerequisites
1212

@@ -18,7 +18,6 @@ The UI comes from a git submodule in `ui/` (the [documentation-ui](https://githu
1818
## Setup
1919

2020
```sh
21-
git submodule update --init # fetch the UI submodule
2221
npm ci # install dependencies
2322
```
2423

@@ -67,7 +66,6 @@ Then open `http://localhost:8000`.
6766
## Quick Start (copy-paste)
6867

6968
```sh
70-
git submodule update --init
7169
npm ci
7270
make ANTORAFLAGS=--fetch build-only-dev
7371
make serve
@@ -77,7 +75,7 @@ make serve
7775

7876
- `antora.yml` — Defines the `home` Antora component (version, nav, attributes)
7977
- `modules/` — Platform-level documentation content (concepts, guides, tutorials, operators, etc.)
80-
- `ui/`Git submodule pointing to [documentation-ui](https://github.com/stackabletech/documentation-ui); bundled by gulp
78+
- `ui/`The site UI (a fork of antora-ui-default, see `ui/UPSTREAM`); bundled by gulp
8179
- `supplemental-ui/` — UI overrides and the `stackable-operator-helpers.js` Antora extension
8280
- `*-playbook.yml` — Antora playbook files (see Build Targets above)
8381
- `cache/` — Antora's git cache directory (gitignored, remove with `make clean`)
@@ -131,7 +129,7 @@ Cross-repo xrefs will break if any sibling repo is on a different branch or has
131129

132130
### UI bundle not found
133131

134-
Run `git submodule update --init` to fetch the UI submodule, then `npm ci` to install dependencies (including gulp).
132+
Run `npm ci` to install dependencies (including gulp), then `make build-ui`.
135133

136134
## Agent Skills
137135

modules/contributor/pages/docs/overview.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
:pagefind: https://pagefind.app/
1212
:stackable-docs-readme: https://github.com/stackabletech/documentation/blob/main/README.adoc
1313
:stackable-docs-repo: https://github.com/stackabletech/documentation
14-
:stackable-docs-ui-repo: https://github.com/stackabletech/documentation-ui
1514
:trunk-based-development: https://trunkbaseddevelopment.com/
1615

1716
We use {antora-docs}[Antora{external-link-icon}^] to write our user facing documentation,
@@ -56,7 +55,7 @@ The xref:docs/style-guide.adoc[] contains all the information about the writing
5655
{antora-docs}[Antora{external-link-icon}^] uses a {antora-playbook}[playbook{external-link-icon}^] to build the documentation.
5756
It pulls documentation content from all the individual operator repositories, so an operators documentation is maintained in the same repository as the code.
5857
Antora builds a static website which we serve over {netlify}[Netlify{external-link-icon}^].
59-
The web template of the documentation is also custom made and is developed in the {stackable-docs-ui-repo}[documentation-ui{external-link-icon}^] repository.
58+
The web template of the documentation is also custom made and lives in the `ui/` directory of the {stackable-docs-repo}[documentation repository{external-link-icon}^].
6059

6160
For search, we use {pagefind}[pagefind{external-link-icon}^] - a static search.
6261
The search index is generated as part of the build process and no external index is queried during search.

0 commit comments

Comments
 (0)