PR Design Doc
OpenHands/OpenHands
For a non-trivial pull request, write a self-contained HTML design doc under the temporary .pr/ directory and link a visibility-appropriate preview in the PR description, so maintainers grasp the…
Route Shift documentation, architecture notes, and tickets correctly.
Install Shift Docs
$ npx skills add shift-editor/shift --skill shift-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install shift-editor/shift shift-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.codex/skills/shift-docs .claude/skills/shift-docs && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .claude/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add shift-editor/shift --skill shift-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install shift-editor/shift shift-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.codex/skills/shift-docs .agents/skills/shift-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .agents/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add shift-editor/shift --skill shift-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install shift-editor/shift shift-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.codex/skills/shift-docs .cursor/skills/shift-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .cursor/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/shift-editor/shift.git --path .codex/skills/shift-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add shift-editor/shift --skill shift-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install shift-editor/shift shift-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.codex/skills/shift-docs .gemini/skills/shift-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .gemini/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install shift-editor/shift shift-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add shift-editor/shift --skill shift-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .github/skills && cp -r skills-src/.codex/skills/shift-docs .github/skills/shift-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .github/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add shift-editor/shift --skill shift-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install shift-editor/shift shift-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shift-editor/shift.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.codex/skills/shift-docs .opencode/skills/shift-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "shift-docs" agent skill from https://github.com/shift-editor/shift/tree/main/.codex/skills/shift-docs into .opencode/skills/shift-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "shift-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
shift-docs- GitHub stars
- 348
- Token cost
- ~272 tokens
- SKILL.md length
- 110 words
- Files
- 2
- Skills in repo
- 14
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
Route Shift documentation, architecture notes, and tickets correctly.
- Works in 3 steps: Read docs/architecture/index.md when… → If the artifact is a ticket, plan, or… → If unsure whether something is stable…
- Codex is about to create
- SKILL.md covers Routing and Before Writing
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Shift Docs is an agent skill from shift-editor/shift. Route Shift documentation, architecture notes, and tickets correctly. Use when Codex is about to create or move docs, write an architecture plan, capture a design decision, create a ticket, or update repo documentation for Shift.
Its SKILL.md is about 270 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).
It sits in Development, covering Architecture decision records. The repository describes itself as: A cross-platform font editor built in Rust and TypeScript. The licence is Apache-2.0.
When your agent uses it
- Codex is about to create
- Write an architecture plan
- Capture a design decision
- Create a ticket
Example prompts
- “/shift-docs”
Workflow steps
3 steps, taken from the first numbered list in SKILL.md.
- Read docs/architecture/index.md when changing stable repo documentation.
- If the artifact is a ticket, plan, or unresolved proposal, route it to Obsidian or GitHub instead of docs/.
- If unsure whether something is stable documentation or a ticket, ask briefly before writing.
What it can do on your machine
Read from SKILL.md and the folder at commit 443dc28. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Shift Docs loads about 272 tokens when it runs. Until then it costs about 60 tokens; SKILL.md has 110 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from shift-editor/shift at commit 443dc28, republished under its Apache-2.0 licence (© shift-editor). 110 words, ~272 tokens.
Download SKILL.mdSave it as
.claude/skills/shift-docs/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- shift-docs
- description
- Route Shift documentation, architecture notes, and tickets correctly. Use when Codex is about to create or move docs, write an architecture plan, capture a design decision, create a ticket, or update repo documentation for Shift.
Shift Docs
Use the right destination for the artifact.
Routing
- Stable repo documentation belongs in
docs/or the module's canonicalDOCS.md, followingdocs/architecture/index.md. - Tickets, design scratchpads, future-work plans, and exploratory architecture proposals do not belong in repo
docs/. - Put tickets and exploratory plans in Obsidian under
~/Documents/KostyaVault/projects/shift/, or open a GitHub issue when the user asks for a tracked issue. - Do not create
CONTEXT.mdfiles.
Before Writing
- Read
docs/architecture/index.mdwhen changing stable repo documentation. - If the artifact is a ticket, plan, or unresolved proposal, route it to Obsidian or GitHub instead of
docs/. - If unsure whether something is stable documentation or a ticket, ask briefly before writing.
© shift-editor, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 1 other file in .codex/skills/shift-docs of shift-editor/shift.
- SKILL.md
- agents/openai.yaml
Open the folder on GitHubat commit 443dc28
Compare with similar skills
Shift Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Shift Docs this skillshift-editor/shift | 348 | — | ~272 | Automated safety check: Pass | Apache-2.0 | |
| PR Design DocOpenHands/OpenHands | 90k | — | ~2.4k | Automated safety check: Pass | MIT | |
| Cto AdvisorIbrahim-3d/orchestrator-supaconductor | 381 | 4 repos | ~2.4k | Automated safety check: Pass | MIT | |
| Architecture DecisionDonchitos/Claude-Code-Game-Studios | 26k | — | ~1.7k | Automated safety check: Pass | MIT | |
| Improve Codebase Architectureywwynm/EverythingDone | 144 | 15 repos | ~1.3k | Automated safety check: Pass | GPL-3.0 | |
| Domain Modelingbrim-borium/spotify_sdk | 166 | 5 repos | ~806 | Automated safety check: Pass | Apache-2.0 |
Similar skills
Cto Advisor
Ibrahim-3d/orchestrator-supaconductor
Technical leadership guidance for engineering teams, architecture decisions, and technology strategy.
Architecture Decision
Donchitos/Claude-Code-Game-Studios
Create an ADR documenting a technical decision: context, alternatives considered, consequences.
Improve Codebase Architecture
ywwynm/EverythingDone
Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/.
Domain Modeling
brim-borium/spotify_sdk
Build and sharpen a project's domain model. An agent skill from brim-borium/spotify_sdk.
Design Doc Mermaid
SpillwaveSolutions/design-doc-mermaid
Create Mermaid diagrams (flowchart, sequence, class, ER, state, C4, architecture) from text or source code.
More from shift-editor/shift
All 14 skills in this repoShift Commit Rules
shift-editor/shift
Rules for writing git commits in the Shift font editor repo: Conventional Commits subjects, user-facing changelog wording, concise subjects and logical commit boundaries.
Dead Code Removal with Knip
shift-editor/shift
Finds unused files, exports and class members with Knip, then verifies each candidate through reference tracing before removing anything, never using knip --fix.
Shift Subsystem Docs
shift-editor/shift
Updates or creates DOCS.md files for Shift subsystems, recording the architecture invariants and constraints that cannot be learned from reading the source.
Adversarial Docs Audit
shift-editor/shift
Fact-checks DOCS.md files against the source code, testing each concrete claim and sorting it as true, false, stale or unverifiable.
Shift Issue Writer
shift-editor/shift
Sets the rules for finding, writing and updating Shift GitHub issues: search for duplicates first, use outcome-focused titles and testable acceptance criteria.
Shift JSDoc Contracts
shift-editor/shift
Guides writing JSDoc for Shift exported APIs as a stable caller contract, covering ownership, lifetime, side effects and nullability that TypeScript types cannot express.
Related
Categories
Questions about Shift Docs
What does Shift Docs do?
Route Shift documentation, architecture notes, and tickets correctly. Shift Docs is an agent skill from shift-editor/shift. Route Shift documentation, architecture notes, and tickets correctly.
When should I use Shift Docs?
Shift Docs fits situations like: Codex is about to create; write an architecture plan; capture a design decision; create a ticket.
How do I install Shift Docs in Claude Code?
Run `npx skills add shift-editor/shift --skill shift-docs -a claude-code`. Or copy the skill folder (.codex/skills/shift-docs in shift-editor/shift) into .claude/skills/shift-docs in your project. Claude Code loads it when a task matches its description.
How do I install Shift Docs in Codex?
Run `npx skills add shift-editor/shift --skill shift-docs -a codex`. Or copy the skill folder (.codex/skills/shift-docs in shift-editor/shift) into .agents/skills/shift-docs in your project. Codex loads it when a task matches its description.
Can I use Shift Docs in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add shift-editor/shift --skill shift-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/shift-docs, .gemini/skills/shift-docs, .github/skills/shift-docs and .opencode/skills/shift-docs in your project.
What does Shift Docs need to run?
SKILL.md names no scripts, command-line tools or credentials: Shift Docs is instructions for the agent only.
Does Shift Docs access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Shift Docs safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Shift Docs use?
Shift Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Shift Docs use?
About 272 tokens (SKILL.md is roughly 1.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Shift Docs?
Skills that share tags, products or a category with Shift Docs: PR Design Doc (OpenHands/OpenHands, 90k stars), Cto Advisor (Ibrahim-3d/orchestrator-supaconductor, 381 stars), Architecture Decision (Donchitos/Claude-Code-Game-Studios, 26k stars) and Improve Codebase Architecture (ywwynm/EverythingDone, 144 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Shift Docs?
shift-editor (a GitHub organization) maintains it in shift-editor/shift, which has 348 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on October 9, 2026.
Source: shift-editor/shift on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.