You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to yorient
1
+
# Contributing to orient
2
2
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.
4
4
5
5
## Where to start
6
6
@@ -14,9 +14,9 @@ Thanks for your interest. `yorient` is small and focused: a Markdown-only orient
14
14
The canonical files are:
15
15
16
16
-`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.
18
18
-`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).
Copy file name to clipboardExpand all lines: .github/SECURITY.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# Security Policy
2
2
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:
4
4
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.
7
7
-**Documented attack patterns** in the skill body (e.g., recommending an unsafe command).
8
8
9
9
## Reporting a vulnerability
10
10
11
11
For anything sensitive, please **do not** file a public issue. Use one of:
12
12
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).
14
14
2.**Email** the maintainer via the address on the GitHub profile at <https://github.com/jqbit>.
15
15
16
16
Include:
@@ -29,5 +29,5 @@ The latest `v1.x` release receives fixes. Older majors are not supported.
29
29
## Out of scope
30
30
31
31
- 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.
33
33
- Reports about commercial support, downtime, or service-level concerns — this is an unstaffed open-source project.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
1
# Changelog
2
2
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`.
-**[`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.
19
23
-**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.
21
25
-**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.
22
26
-**`.gitattributes`.** Normalizes line endings (`text=auto eol=lf`), marks `*.md` files as `linguist-language=Markdown` so GitHub's language bar counts them correctly.
23
27
-**Branch protection.**`main` now requires linear history; force-pushes and deletions blocked.
24
28
25
29
### Fixed
26
30
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.
29
33
30
34
### Deferred to v1.5+
31
35
@@ -38,13 +42,13 @@ Initial public release. Closes 10 gaps surfaced in an internal audit of the v1.2
38
42
### Added
39
43
40
44
-**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.
42
46
-**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.
44
48
-**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.
45
49
-**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.
46
50
-**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.
48
52
-**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.
49
53
-**Cursor IDE vs CLI distinction** in the Agent Adapter Targets table.
50
54
-**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
62
66
63
67
## [1.2.0] — pre-release baseline
64
68
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`.
|___YORIENT.md # this file — yorient applied to its own repo
28
+
|___ORIENT.md # this file — orient applied to its own repo
29
29
|___AGENTS.md # thin adapter (managed block)
30
30
|___CLAUDE.md # thin adapter (managed block)
31
31
|___CHANGELOG.md # semver release log
@@ -65,7 +65,7 @@ yorient/
65
65
66
66
- Markdown only. No scripts in the skill workflow (meta scripts in `.github/workflows/` are fine).
67
67
-`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.
69
69
- Versioned managed-block markers (`v=1`). Legacy `v=0` blocks are detected and upgraded; never silently rewritten with a different format.
70
70
- Semver. `CHANGELOG.md` entry per release.
71
71
@@ -77,10 +77,10 @@ yorient/
77
77
78
78
## Subsystem Notes
79
79
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.
81
81
82
82
## Maintenance
83
83
84
84
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).
0 commit comments