Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
01a303b
Overture docs V2 update
MitchellShiell Jul 24, 2026
a1c2194
submodule update
MitchellShiell Jul 24, 2026
b812ff2
submodule update
MitchellShiell Jul 24, 2026
f66a63c
base page updates + overall organization
MitchellShiell Jul 27, 2026
4c32ec4
submodule update
MitchellShiell Jul 27, 2026
cdccf04
punctuation update
MitchellShiell Jul 27, 2026
ebbc436
Expand and split the AI-Assisted Data Discovery guide into multiple p…
MitchellShiell Jul 27, 2026
e629cbc
updated file transfer guides
MitchellShiell Jul 27, 2026
3d5bffe
first round review
MitchellShiell Jul 28, 2026
ba411de
submodule update
MitchellShiell Jul 28, 2026
eba8a74
minor correction
MitchellShiell Jul 28, 2026
b48640a
updated deploy docs sidebar
MitchellShiell Jul 28, 2026
f44d4b5
minor fixes
MitchellShiell Jul 28, 2026
4a76863
submodule update
MitchellShiell Jul 29, 2026
790ce75
submodule + use doc update
MitchellShiell Jul 29, 2026
00485d4
minor update
MitchellShiell Jul 29, 2026
3506ed1
fixed search engine page failing build
MitchellShiell Jul 29, 2026
94271a6
song playground update
MitchellShiell Jul 29, 2026
020a95f
playground + arranger updates
MitchellShiell Jul 29, 2026
2e817c9
link & submodule updates
MitchellShiell Jul 30, 2026
ed0584e
bump song + score pins: drop formatter-only Java churn from doc branches
MitchellShiell Jul 30, 2026
1b82f3d
bump song pin: doc branch rebased onto develop
MitchellShiell Jul 30, 2026
ee771bc
bump score pin: doc branch rebased onto develop
MitchellShiell Jul 30, 2026
0ac94d4
bump stage pin: doc branch rebased onto main
MitchellShiell Jul 30, 2026
5e84984
bump lectern pin: doc branch rebased onto main
MitchellShiell Jul 30, 2026
3c80c2d
bump maestro pin: doc branch rebased onto M5-revised
MitchellShiell Jul 30, 2026
8fc27dd
bump arranger pin: doc branch rebased onto main
MitchellShiell Jul 30, 2026
7a10f91
bump lectern pin: fix broken #field-restrictions anchor
MitchellShiell Jul 30, 2026
3085217
bump submodule pins: docs link hygiene fixes
MitchellShiell Aug 4, 2026
dbef063
lectern submodule update
MitchellShiell Aug 4, 2026
8f635ca
lectern submodule commit update
MitchellShiell Aug 4, 2026
138ba32
submodule update
MitchellShiell Aug 5, 2026
50197ae
lectern submodule update
MitchellShiell Aug 5, 2026
14bd275
readme + submodule update
MitchellShiell Aug 5, 2026
efaf70d
project setup
MitchellShiell Aug 6, 2026
f5fda1e
Merge origin/main into overtureWebsiteUpdate
MitchellShiell Aug 6, 2026
486f968
Port the Gatsby marketing site into Docusaurus (stage 1)
MitchellShiell Aug 6, 2026
4be74b3
fixed styling issues
MitchellShiell Aug 6, 2026
5cb44c4
tailwind update
MitchellShiell Aug 7, 2026
714a664
updated navigation
MitchellShiell Aug 7, 2026
638d783
Rebuild the marketing site around the new IA
MitchellShiell Aug 7, 2026
7be3742
hero + carousel update
MitchellShiell Aug 10, 2026
cb97a6a
hero adjustments
MitchellShiell Aug 11, 2026
aec7a03
major update
MitchellShiell Aug 11, 2026
f38d0f7
removed impact statment from carousel
MitchellShiell Aug 11, 2026
f53081f
fixed link out icons in navbar
MitchellShiell Aug 11, 2026
09fdfe6
cleaned up navbar
MitchellShiell Aug 11, 2026
01e19de
impact page update
MitchellShiell Aug 12, 2026
97c2a80
improved navigation
MitchellShiell Aug 12, 2026
8ecdd0d
minor highlighting fix
MitchellShiell Aug 12, 2026
07bac75
small highlighting update
MitchellShiell Aug 13, 2026
b2da636
anchor tags for headings
MitchellShiell Aug 13, 2026
045a333
clean up
MitchellShiell Aug 13, 2026
5b9dd6f
clean up
MitchellShiell Aug 13, 2026
315eb54
updated impact table links
MitchellShiell Aug 13, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ The canonical task→convention dispatch table lives in `~/.claude/agentics/temp
## Project context
Overture Docs is the **centralized documentation site for the Overture stack**, built with [Docusaurus](https://docusaurus.io/). It aggregates Markdown from the `/docs` directory of each Overture project repository (pulled in as git submodules) and renders them as one navigable site. The point of the setup is that documentation stays with its source project while readers get a single hub. Full overview in [README.md](README.md); planned work lives in `.dev/roadmap.md`.

## Verifying a UI change

A clean `npm run build` says a page compiled, not that it looks right. Before calling any visual change done, render it and look at it.

- Build and serve: `cd website && npm run build && npm run serve --port <port>`. `npm start` renders in the browser, so its HTML is an empty shell and tells you nothing.
- Screenshot with a real browser at a real viewport. Chrome's `--headless --screenshot --window-size` is unreliable: the window size is not the CSS viewport, and it will show you clipping and overflow that do not exist. Drive it with `puppeteer-core` and `page.setViewport` instead, pointing `executablePath` at the installed Chrome. Install it outside this repo (the scratchpad), never as a dependency here.
- Check the widths that change behaviour, not just the one you are working at. The marketing navbar collapses at 1160px.
- When something looks wrong, measure it in the page (`getComputedStyle`, `getBoundingClientRect`, `scrollWidth` against `clientWidth`) before changing CSS. Reading a screenshot is guessing.
- Check a documentation page too whenever marketing styles or theme components change, since both sites share one build.

## Project-specific constraints
- **Public repository** (`overture-stack/docs`): no credentials, secrets, tokens, or private URLs in any committed file, ever.
- **Documentation content is owned by the submodules, not this repo.** Each project's docs live in `submodules/<project>/docs/` and are symlinked into `website/docs/`. Edit the **source** file under `submodules/<project>/`, never the symlinked copy under `website/docs/`: editing through the link mutates the vendored submodule's working tree in a way that is easy to lose and confusing to review. Symlinks are (re)generated by `symlinker.sh`.
Expand All @@ -24,7 +34,10 @@ Overture Docs is the **centralized documentation site for the Overture stack**,

## Repository orientation
- `submodules/` — vendored Overture repos as git submodules: `arranger`, `lectern`, `lyric`, `maestro`, `score`, `song`, `stage`, and `.github`. Each carries its own `/docs`. Defined in `.gitmodules` (see `.dev/roadmap.md`: release-branch tracking is not yet configured, so `git submodule update --remote` currently follows each repo's default branch).
- `website/` — the Docusaurus site: `docs/` (aggregated, symlinked from submodules), `community/`, `guides/`, and `src/` (`components/`, `css/`, `theme/`, `pages/`).
- `website/` — the Docusaurus site: `docs/` (aggregated, symlinked from submodules), `community/`, `guides/`, and `src/` (`components/`, `css/`, `marketing/`, `theme/`, `pages/`).
- `website/src/marketing/`: the overture.bio marketing pages ported from the Gatsby site: components, constants, case-study data, and the Sass tree. Its styles are all imported inside `.marketing` by `styles/index.scss`, and only `MarketingPage.tsx` imports that file, which is what keeps Bulma off the documentation pages in the same build. Add marketing styles as a partial imported there, never as a stray `import "./styles.scss"` in a component.
- `symlinker.sh` — regenerates the symlinks that bring selected submodule `/docs` files into `website/docs/`.
- `website/netlify/` — configuration staged for stage 3 of the overture.bio port, not read by anything today. This repo has no live `netlify.toml`: `docs.overture.bio` is configured through the Netlify UI, and committing one would move that configuration out from under a working site. See the README in that directory before adding anything to it.
- `website-legacy/` is **gone** as of 2026-08-07. It was a staged copy of the [overture-stack/website](https://github.com/overture-stack/website) Gatsby site, kept while the port ran. Everything it held is either ported into `website/` or still in that repo, which is what serves overture.bio until stage 3 and is cloned locally at `~/Desktop/website`. Changes that need to reach the live site go there, not here.
- `README.md`, `preview.png` — human-facing project overview and screenshot.
- Local setup: Node 18+, `npm ci`, then `npm start` (see `README.md` § Getting Started).
Loading