Skip to content

Commit cdc4cd3

Browse files
committed
Rebrand yorient to orient (v1.5.0)
Rename YORIENT.md to ORIENT.md, switch managed blocks to ORIENT/ORIENT-README, update skill slug and jqbit/orient URLs, and document legacy YORIENT migration.
1 parent 6ae6f6b commit cdc4cd3

12 files changed

Lines changed: 246 additions & 233 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to yorient
1+
# Contributing to orient
22

3-
Thanks for your interest. `yorient` is small and focused: a Markdown-only orientation skill for AI coding agents. Most useful contributions fall into a few shapes.
3+
Thanks for your interest. `orient` is small and focused: a Markdown-only orientation skill for AI coding agents. Most useful contributions fall into a few shapes.
44

55
## Where to start
66

@@ -14,9 +14,9 @@ Thanks for your interest. `yorient` is small and focused: a Markdown-only orient
1414
The canonical files are:
1515

1616
- `SKILL.md` — the skill body. Frontmatter `name:` and `version:` matter for ecosystem compatibility.
17-
- `references/``rebrand-and-pointer-blocks.md`, `example-YORIENT.md`, `by-ecosystem.md`. Reference material the skill body links to.
17+
- `references/``rebrand-and-pointer-blocks.md`, `example-ORIENT.md`, `by-ecosystem.md`. Reference material the skill body links to.
1818
- `README.md`, `CHANGELOG.md`, `LICENSE` — repo-only. Not synced to agent skill installs.
19-
- `YORIENT.md`, `AGENTS.md`, `CLAUDE.md` — the skill applied to its own repo (dogfood).
19+
- `ORIENT.md`, `AGENTS.md`, `CLAUDE.md` — the skill applied to its own repo (dogfood).
2020

2121
## Local checks before opening a PR
2222

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ body:
88
Thanks for taking the time to file a bug. A few sentences plus a pointer to the exact file and line is usually enough.
99
1010
- type: input
11-
id: yorient-version
11+
id: orient-version
1212
attributes:
13-
label: yorient version
13+
label: orient version
1414
description: From `SKILL.md` frontmatter `version:` field, or the GitHub release tag you cloned.
15-
placeholder: "v1.4.0"
15+
placeholder: "v1.5.0"
1616
validations:
1717
required: true
1818

.github/SECURITY.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Security Policy
22

3-
`yorient` is a documentation-only skill: Markdown files plus a small managed-block algorithm specification. It does not ship executable code, does not invoke remote services, and does not handle credentials. The realistic threat surface is therefore narrow:
3+
`orient` is a documentation-only skill: Markdown files plus a small managed-block algorithm specification. It does not ship executable code, does not invoke remote services, and does not handle credentials. The realistic threat surface is therefore narrow:
44

5-
- **Markdown injection** into a downstream agent's context (e.g., a `YORIENT.md` crafted to mislead an agent into a harmful action). Mitigated upstream by the agents that read the file; report cases where the skill's recommended shape makes injection materially easier.
6-
- **Supply-chain confusion** — a typosquatted clone of this repo or a malicious mirror under the `yorient` name.
5+
- **Markdown injection** into a downstream agent's context (e.g., a `ORIENT.md` crafted to mislead an agent into a harmful action). Mitigated upstream by the agents that read the file; report cases where the skill's recommended shape makes injection materially easier.
6+
- **Supply-chain confusion** — a typosquatted clone of this repo or a malicious mirror under the `orient` name.
77
- **Documented attack patterns** in the skill body (e.g., recommending an unsafe command).
88

99
## Reporting a vulnerability
1010

1111
For anything sensitive, please **do not** file a public issue. Use one of:
1212

13-
1. **GitHub private security advisory** — open at <https://github.com/jqbit/yorient/security/advisories/new> (preferred).
13+
1. **GitHub private security advisory** — open at <https://github.com/jqbit/orient/security/advisories/new> (preferred).
1414
2. **Email** the maintainer via the address on the GitHub profile at <https://github.com/jqbit>.
1515

1616
Include:
@@ -29,5 +29,5 @@ The latest `v1.x` release receives fixes. Older majors are not supported.
2929
## Out of scope
3030

3131
- Reports about an agent ecosystem's own behavior unrelated to this skill.
32-
- Reports about user-authored `YORIENT.md` content in third-party repos.
32+
- Reports about user-authored `ORIENT.md` content in third-party repos.
3333
- Reports about commercial support, downtime, or service-level concerns — this is an unstaffed open-source project.

AGENTS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!-- YORIENT:BEGIN v=1 -->
2-
# Yorient Map
1+
<!-- ORIENT:BEGIN v=1 -->
2+
# Orient Map
33

4-
This project uses `YORIENT.md` as the canonical repo/vault map.
4+
This project uses `ORIENT.md` as the canonical repo/vault map.
55

66
Before broad file search or structural edits:
7-
1. Read `YORIENT.md`.
8-
2. Check for a nearer nested `YORIENT.md` or `AGENTS.md` in the target subtree.
7+
1. Read `ORIENT.md`.
8+
2. Check for a nearer nested `ORIENT.md` or `AGENTS.md` in the target subtree.
99
3. Use the routing map there to choose files and commands.
10-
4. Keep this adapter thin; update `YORIENT.md` when structure changes.
11-
<!-- YORIENT:END v=1 -->
10+
4. Keep this adapter thin; update `ORIENT.md` when structure changes.
11+
<!-- ORIENT:END v=1 -->

CHANGELOG.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Changelog
22

3-
All notable changes to `yorient` are documented here. This project follows [Semantic Versioning](https://semver.org/).
3+
All notable changes to `orient` are documented here. This project follows [Semantic Versioning](https://semver.org/).
4+
5+
## [1.5.0] — 2026-06-05
6+
7+
Full rebrand from `yorient` / `YORIENT.md` to `orient` / `ORIENT.md`. Canonical managed-block anchors are `ORIENT` and `ORIENT-README`; legacy `YORIENT` families are detected and upgraded in place. GitHub URLs point at `jqbit/orient`.
48

59
## [1.4.0] — 2026-05-25
610

@@ -15,17 +19,17 @@ Post-release audit pass. Three parallel review tracks (content correctness, repo
1519

1620
### Added
1721

18-
- **[`agents.md`](https://agents.md) citation.** A new paragraph at the top of `## Agent Adapter Targets` names the convention, links the spec, and clarifies that yorient layers atop `AGENTS.md` rather than replacing it.
22+
- **[`agents.md`](https://agents.md) citation.** A new paragraph at the top of `## Agent Adapter Targets` names the convention, links the spec, and clarifies that orient layers atop `AGENTS.md` rather than replacing it.
1923
- **Community scaffolding (`.github/`).** `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md` (Contributor Covenant 2.1), `SECURITY.md`, `ISSUE_TEMPLATE/bug-report.yml`, `ISSUE_TEMPLATE/feature-request.yml`, `PULL_REQUEST_TEMPLATE.md`. Community-health score expected to jump from 42% → ≥80%.
20-
- **Dogfood.** This repo now applies yorient to itself: a root `YORIENT.md` map, minimal `AGENTS.md` and `CLAUDE.md` adapter files (just the managed block), and a `YORIENT-README:BEGIN v=1` block appended to `README.md`. The repo is its own live demo.
24+
- **Dogfood.** This repo now applies orient to itself: a root `ORIENT.md` map, minimal `AGENTS.md` and `CLAUDE.md` adapter files (just the managed block), and a `ORIENT-README:BEGIN v=1` block appended to `README.md`. The repo is its own live demo.
2125
- **CI safety net.** `.github/workflows/checks.yml` runs `markdownlint-cli2` plus `lychee` link checks (internal hard-fail, external warn-only) on every push and pull request. `.markdownlint.json` provides a permissive baseline tuned to this repo's prose-and-table style.
2226
- **`.gitattributes`.** Normalizes line endings (`text=auto eol=lf`), marks `*.md` files as `linguist-language=Markdown` so GitHub's language bar counts them correctly.
2327
- **Branch protection.** `main` now requires linear history; force-pushes and deletions blocked.
2428

2529
### Fixed
2630

27-
- **Nested fence in `references/example-YORIENT.md`.** The outer wrapper now uses 4 backticks so it correctly contains the inner 3-backtick `text` fences (CommonMark spec).
28-
- **README managed-block placement** added per the dogfood pass, demonstrating the YORIENT-README block on the repo's own README.
31+
- **Nested fence in `references/example-ORIENT.md`.** The outer wrapper now uses 4 backticks so it correctly contains the inner 3-backtick `text` fences (CommonMark spec).
32+
- **README managed-block placement** added per the dogfood pass, demonstrating the ORIENT-README block on the repo's own README.
2933

3034
### Deferred to v1.5+
3135

@@ -38,13 +42,13 @@ Initial public release. Closes 10 gaps surfaced in an internal audit of the v1.2
3842
### Added
3943

4044
- **Managed block algorithm** (`SKILL.md § Managed Block Algorithm`). Explicit, idempotent rule for inserting, replacing, and de-duplicating pointer blocks. Re-running the skill on an unchanged file is now guaranteed byte-identical.
41-
- **Versioned block markers.** All managed blocks now use `<!-- YORIENT:BEGIN v=1 -->` / `<!-- YORIENT:END v=1 -->` (and `YORIENT-README:BEGIN v=1` / `YORIENT-README:END v=1`). Unversioned legacy blocks are detected as `v=0` and upgraded in place. Future schema versions can be added without breaking past content.
45+
- **Versioned block markers.** All managed blocks now use `<!-- ORIENT:BEGIN v=1 -->` / `<!-- ORIENT:END v=1 -->` (and `ORIENT-README:BEGIN v=1` / `ORIENT-README:END v=1`). Unversioned legacy blocks are detected as `v=0` and upgraded in place. Future schema versions can be added without breaking past content.
4246
- **Adapter-block placement rule.** Concrete rule for where the block goes in new vs existing adapter files (new file → under the first H1; existing file → appended at end with one blank line above/below).
43-
- **Worked example** (`references/example-YORIENT.md`). Fully filled-in `YORIENT.md` for a hypothetical Node monorepo. Calibration target for length, density, and voice.
47+
- **Worked example** (`references/example-ORIENT.md`). Fully filled-in `ORIENT.md` for a hypothetical Node monorepo. Calibration target for length, density, and voice.
4448
- **Ecosystem cheatsheet** (`references/by-ecosystem.md`). Per-ecosystem manifest files, source/test conventions, "read first" hints, and common no-go directories for Node/TS, Python, Rust, Go, polyglot monorepos, docs sites, and Obsidian vaults.
4549
- **Drift check** (`SKILL.md § Drift Check`). Five-step verification recipe — Tree Map paths still exist, commands still parse, top-level dirs match disk, no-go zones still real, `Last reviewed:` stamp.
4650
- **Smoke test** (`SKILL.md § Smoke Test`). Per-agent installation verification steps for Claude Code, Codex, Hermes, Cursor CLI, Factory, Pi, OpenCode, Gemini, and Antigravity.
47-
- **Commit stance** (`SKILL.md § Commit Stance`). Explicit guidance that `YORIENT.md` and managed pointer blocks are committed artifacts.
51+
- **Commit stance** (`SKILL.md § Commit Stance`). Explicit guidance that `ORIENT.md` and managed pointer blocks are committed artifacts.
4852
- **Slug source callout** (`SKILL.md § Branding Rules § Slug Source`). The footgun about frontmatter `name:` driving the callable slug is now surfaced at the top of the Branding Rules, not buried in pitfalls.
4953
- **Cursor IDE vs CLI distinction** in the Agent Adapter Targets table.
5054
- **Migration playbook** (`references/rebrand-and-pointer-blocks.md`). Now includes concrete detection regexes, a three-branch decision tree for legacy `ORIENT.md` files, and an explicit string replacement map.
@@ -62,4 +66,4 @@ Initial public release. Closes 10 gaps surfaced in an internal audit of the v1.2
6266

6367
## [1.2.0] — pre-release baseline
6468

65-
Initial internal release covering portable `YORIENT.md` shape, agent adapter targets table, parallel subtree exploration, basic managed blocks, Obsidian/vault variant, and verification checklist. Used internally to rebrand from `orient-map`.
69+
Initial internal release covering portable `ORIENT.md` shape, agent adapter targets table, parallel subtree exploration, basic managed blocks, Obsidian/vault variant, and verification checklist. Used internally to rebrand from `orient-map`.

CLAUDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
<!-- YORIENT:BEGIN v=1 -->
2-
# Yorient Map
1+
<!-- ORIENT:BEGIN v=1 -->
2+
# Orient Map
33

4-
This project uses `YORIENT.md` as the canonical repo/vault map.
4+
This project uses `ORIENT.md` as the canonical repo/vault map.
55

66
Before broad file search or structural edits:
7-
1. Read `YORIENT.md`.
8-
2. Check for a nearer nested `YORIENT.md` or `AGENTS.md` in the target subtree.
7+
1. Read `ORIENT.md`.
8+
2. Check for a nearer nested `ORIENT.md` or `AGENTS.md` in the target subtree.
99
3. Use the routing map there to choose files and commands.
10-
4. Keep this adapter thin; update `YORIENT.md` when structure changes.
11-
<!-- YORIENT:END v=1 -->
10+
4. Keep this adapter thin; update `ORIENT.md` when structure changes.
11+
<!-- ORIENT:END v=1 -->

YORIENT.md renamed to ORIENT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# YORIENT.md
1+
# ORIENT.md
22

33
## Purpose
44

5-
This is the public repo for the `yorient` skill — a Markdown-only orientation
5+
This is the public repo for the `orient` skill — a Markdown-only orientation
66
layer for AI coding agents. The repo is its own demo: it ships the skill, and
77
also uses the skill on itself.
88

@@ -11,21 +11,21 @@ also uses the skill on itself.
1111
- Want to read the skill itself? `SKILL.md`.
1212
- Want to install the skill into your agents? `README.md § Install`.
1313
- Want to extend or modify the skill? `.github/CONTRIBUTING.md`, then `SKILL.md`.
14-
- Want a worked example of a `YORIENT.md`? `references/example-YORIENT.md`.
15-
- Want to migrate from `orient-map` or `ORIENT.md`? `references/rebrand-and-pointer-blocks.md`.
14+
- Want a worked example of a `ORIENT.md`? `references/example-ORIENT.md`.
15+
- Want to migrate from `yorient`, `YORIENT.md`, or `orient-map`? `references/rebrand-and-pointer-blocks.md`.
1616
- Tracking releases? `CHANGELOG.md`.
1717

1818
## Tree Map
1919

2020
```text
21-
yorient/
21+
orient/
2222
|___SKILL.md # the skill body (canonical)
2323
|___references/
2424
| |___rebrand-and-pointer-blocks.md # migration playbook + detection regex
25-
| |___example-YORIENT.md # fully worked YORIENT.md (Node monorepo)
25+
| |___example-ORIENT.md # fully worked ORIENT.md (Node monorepo)
2626
| |___by-ecosystem.md # per-ecosystem entrypoint cheatsheet
2727
|___README.md # public-facing pitch + install
28-
|___YORIENT.md # this file — yorient applied to its own repo
28+
|___ORIENT.md # this file — orient applied to its own repo
2929
|___AGENTS.md # thin adapter (managed block)
3030
|___CLAUDE.md # thin adapter (managed block)
3131
|___CHANGELOG.md # semver release log
@@ -65,7 +65,7 @@ yorient/
6565

6666
- Markdown only. No scripts in the skill workflow (meta scripts in `.github/workflows/` are fine).
6767
- `SKILL.md` and `references/*.md` are the *canonical skill*; they get mirrored into agent skill directories.
68-
- `README.md`, `CHANGELOG.md`, `LICENSE`, `YORIENT.md`, `AGENTS.md`, `CLAUDE.md`, `.github/`, `.gitattributes`, `.markdownlint.json` are *repo-only*; they do not sync to skill mirrors.
68+
- `README.md`, `CHANGELOG.md`, `LICENSE`, `ORIENT.md`, `AGENTS.md`, `CLAUDE.md`, `.github/`, `.gitattributes`, `.markdownlint.json` are *repo-only*; they do not sync to skill mirrors.
6969
- Versioned managed-block markers (`v=1`). Legacy `v=0` blocks are detected and upgraded; never silently rewritten with a different format.
7070
- Semver. `CHANGELOG.md` entry per release.
7171

@@ -77,10 +77,10 @@ yorient/
7777

7878
## Subsystem Notes
7979

80-
This repo is small enough that no nested `<subtree>/YORIENT.md` files are needed.
80+
This repo is small enough that no nested `<subtree>/ORIENT.md` files are needed.
8181

8282
## Maintenance
8383

8484
Update this file when top-level files change shape (new `references/*.md`, new repo-only file, ecosystem additions to the adapter table that would change the routing map).
8585

86-
Last reviewed: 2026-05-25.
86+
Last reviewed: 2026-06-05.

0 commit comments

Comments
 (0)