Skip to content

docs: intent spec docs-sync directive (intentfile.org + this site) #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
delchev merged 1 commit into from
Jul 27, 2026
Merged

docs: intent spec docs-sync directive (intentfile.org + this site) #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,23 @@ The Monitoring perspective is at `ide/perspectives/monitoring.md` + three views
- **Cross-links are absolute** — `/help/...`, `/api/...`, `/sdk/...`, `/sdks/...`. `ignoreDeadLinks: true` is on; that masks broken links at build time, so run the dead-link scanner manually (see "Operational scripts" below) before publishing significant changes.
- **Frontmatter on every page** — `---\ntitle: ...\ndescription: ...\n---`. If `description` starts with `@` (e.g. `@Inject`) quote it: `description: "@Inject + @Repository"`. Bare `@` at the start of a YAML scalar fails to parse.

## Intent spec docs sync (intentfile.org + this site)

`intentfile.org` (repo `IntentFile/intentfile.github.io`) is THE intent **specification** - a
vendor-neutral, normative doc site. Its DSL is implemented by the `engine-intent` reference
implementation in the platform. This site (`dirigible.io`) carries the platform-branded intent
docs under `/help/intent/`.

**Directive (normative):** any intent DSL addition/change updates BOTH sites in the same effort:

- **`intentfile.org`** - open a PR and **leave it OPEN (do NOT merge)**; the maintainer
reviews/merges the public spec. Neutral wording ONLY: no vendor/platform names (no Dirigible /
Eclipse / product names), and NEVER a `CLAUDE.md` / `MEMORY.md` or any AI/meta file in that repo.
- **`dirigible.io`** (this repo) - open a PR and **merge it**.

Derive the neutral wording for the spec from the platform docs (or vice versa); the two must stay
in lockstep with the parser/generators.

## SDK organisation

The two SDKs are siblings, not parent/child:
Expand Down