Neat-Freak Knowledge Closeout
KKKKhazix/khazix-skills
Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.
Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.
Install Documentation
$ npx skills add samchon/typia --skill documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install samchon/typia documentation --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/samchon/typia.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation .claude/skills/documentation && 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 "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .claude/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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/samchon/typia/tree/master/.agents/skills/documentationType 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 samchon/typia --skill documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install samchon/typia documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/samchon/typia.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/documentation .agents/skills/documentation && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .agents/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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 samchon/typia --skill documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install samchon/typia documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/samchon/typia.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/documentation .cursor/skills/documentation && 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 "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .cursor/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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/samchon/typia.git --path .agents/skills/documentation--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 samchon/typia --skill documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install samchon/typia documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/samchon/typia.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/documentation .gemini/skills/documentation && 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 "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .gemini/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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 samchon/typia documentationInstalls 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 samchon/typia --skill documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/samchon/typia.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/documentation .github/skills/documentation && 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 "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .github/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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 samchon/typia --skill documentation -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install samchon/typia documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/samchon/typia.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/documentation .opencode/skills/documentation && 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 "documentation" agent skill from https://github.com/samchon/typia/tree/master/.agents/skills/documentation into .opencode/skills/documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation", 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
documentation- GitHub stars
- 5.9k
- Token cost
- ~1.1k tokens
- SKILL.md length
- 627 words
- Files
- 1
- Skills in repo
- 6
- Repo updated
- First seen
- Licence
- MIT
At a glance
Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.
- Tasks that involve Agent instruction files
- SKILL.md covers READMEs, Guide Documents, Agent Instructions and Prose line breaks, plus 1 more section
- Calls pnpm
- Tasks that involve Technical documentation
What it does
Documentation is an agent skill from samchon/typia. Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia. Use before writing, modifying, renaming, or moving repository documentation.
Its SKILL.md is about 1.1k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Agent Workflows, covering Agent instruction files and Technical documentation. It works with gRPC and TypeScript. The repository describes itself as: Super-fast/easy runtime validators and serializers via transformation. The licence is MIT.
When your agent uses it
- Tasks that involve Agent instruction files
- Tasks that involve Technical documentation
Example prompts
- “Use the documentation skill to define README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia”
- “/documentation”
What it can do on your machine
Read from SKILL.md and the folder at commit d9d3436. 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
Shell commands in SKILL.md call:
pnpm
From the folder's file list and the shell code blocks in SKILL.md.
Network
Links to these hosts (documentation or services it may open):
typia.io
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
Documentation loads about 1.1k tokens when it runs. Until then it costs about 51 tokens; SKILL.md has 627 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 samchon/typia at commit d9d3436, republished under its MIT licence (© samchon). 627 words, ~1,120 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation/SKILL.md (or your agent's skills folder).- name
- documentation
- description
- Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia. Use before writing, modifying, renaming, or moving repository documentation.
Documentation
READMEs
README files are for the final reader of that package or directory. Start with what it is, when to use it, installation, the smallest working setup, and the common path.
Keep README language direct and practical. Avoid compiler theory, protocol details, internal architecture, and edge cases unless the reader must know them to use the package. Move deep explanations into the website guides and link them only as the next step.
Guide Documents
User-facing guides live under website/src/content/docs/** as MDX and publish at https://typia.io/docs. The site uses Next.js and Nextra, exports a static site, and deploys to GitHub Pages. Keep one audience and one task per page.
The current tree is organized by feature area:
- top-level pages
index.mdx,setup.mdx,pure.mdx,random.mdx, andmisc.mdxcover introduction, setup, and cross-cutting features; validators/,json/,protobuf/, andllm/own their operation guides; andutilization/owns framework integrations for MCP, Vercel AI SDK, LangChain, NestJS, tRPC, and Hono.
The root and each guide folder use _meta.ts for sidebar order and labels. Nextra reads keys in declaration order; { display: "hidden" } keeps a page reachable while removing it from the sidebar. Update the matching _meta.ts whenever a guide is added, renamed, moved, hidden, or exposed.
When emitted code is the point, pair the TypeScript source with its compiled JavaScript in side-by-side tabs so the reader can see what the transform replaces. Back performance claims with a specific benchmark result instead of an adjective. Follow the fresh website-build prerequisites in .agents/skills/development/SKILL.md.
Agent Instructions
AGENTS.md and SKILL.md files are operational documents for humans and agents. Keep only the product-wide contract in AGENTS.md, the always-applicable procedure in SKILL.md, and conditional detail in a linked sibling document.
Concise and clear means:
- Include the context needed to act correctly. Do not make the reader infer prerequisites, exceptions, reasons, or stop conditions merely to shorten the document.
- State each rule at its owning document and link to it elsewhere. Remove repeated wording, not necessary substance.
- Give each paragraph one job. Separate purpose, rule, rationale, procedure, and consequence when combining them obscures the action.
- Use structure to compress meaning: ordered lists for procedures, bullets for choices and checks, tables for repeated mappings, and code blocks for exact commands.
- State the rule before its reason. Use a negative rule only when it prevents a named failure the affirmative rule does not already exclude.
- Link to website guides, READMEs, or source comments instead of paraphrasing them.
Show full SKILL.md (225 more words)Show less
Prose line breaks
Write each Markdown or MDX paragraph on one source line. Never hard-wrap a single paragraph at a fixed column: Markdown already soft-wraps it, while manual wrapping makes small edits reflow unrelated lines.
One source line does not mean one long paragraph. Insert a blank line whenever the idea changes. Keep structural line breaks for paragraphs, list items, headings, tables, and fenced code.
This is a manual convention, not a formatter gate. Root pnpm format runs Prettier over **/*.ts and formats changed Go files; it does not format *.md or *.mdx, and the repository does not set proseWrap. Preserve one-line paragraphs yourself.
Voice
Write in the plain, direct, technical voice of the human-authored typia docs. Do not write like an AI assistant.
- No AI-cliche phrasing: "not only X but also Y", "whether you're X or Y", "it's worth noting", "let's dive in", and reflexive hedging.
- No marketing adjectives such as "seamless", "powerful", "robust", or "effortless". State the behavior; where speed is the point, cite the benchmark.
- No wrap-up sentence that just restates the paragraph. State the fact and stop.
- Em-dashes already fit the existing typia prose; do not remove them mechanically or impose a punctuation ban.
- Sidebar emoji in
_meta.tsare part of the existing navigation voice. Keep them where they already fit; this exception does not turn guide prose into decorative copy.
© samchon, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/documentation of samchon/typia.
Open the folder on GitHubat commit d9d3436
Compare with similar skills
Documentation 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 |
|---|---|---|---|---|---|---|
| Documentation this skillsamchon/typia | 5.9k | — | ~1.1k | Automated safety check: Pass | MIT | |
| Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills | 21k | — | ~1.9k | Automated safety check: Pass | MIT | |
| Dsh Web Documentationzhu1090093659/dsh-web | 8.4k | — | ~479 | Automated safety check: Pass | Apache-2.0 | |
| Newprojectscunning1975/MixtapeTools | 469 | 1 repos | ~850 | Automated safety check: Pass | None | |
| Sync Public DocsCaldis/react-zmage | 946 | — | ~3.3k | Automated safety check: Pass | MIT | |
| Review DocsKaggle/kaggle-environments | 454 | — | ~2.7k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Dsh Web Documentation
zhu1090093659/dsh-web
A skill your agent uses when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.
Newproject
scunning1975/MixtapeTools
Scaffold a new research project with standard directory structure, CLAUDE.md template, and documented README.
Sync Public Docs
Caldis/react-zmage
A skill your agent uses when modifying public API in packages/core (types/global.ts, types/default.ts, index.ts, or package.json exports field), adding/renaming/removing props, changing default…
Review Docs
Kaggle/kaggle-environments
Audit a game environment's README.md and AGENTS.md against its engine implementation.
Init Rules
lifedever/claude-rules
Initialize or update CLAUDE.md coding standards for any project by auto-detecting tech stack and assembling rules from the claude-rules template library.
More from samchon/typia
Project
samchon/typia
Defines the typia product contract, workspace layout, package boundaries, and canonical commands.
Development
samchon/typia
Defines typia implementation rules, testing standards, validation, consequence analysis, and change integrity.
Issue Campaign
samchon/typia
Defines the default solo repository-wide issue campaign for typia: exhaustive discovery, lead-vetted issue publication, one unified CI-validated implementation pull request per cycle, solo…
Review
samchon/typia
Defines exhaustive solo review, Self-Review, and solo repository-wide issue-discovery rounds for typia.
Benchmark
samchon/typia
Defines typia benchmark fixture integrity, result reporting, and publication safeguards.
Related
Works with
Categories
Questions about Documentation
What does Documentation do?
Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia. Documentation is an agent skill from samchon/typia. Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.
When should I use Documentation?
Documentation fits situations like: tasks that involve Agent instruction files; tasks that involve Technical documentation.
How do I install Documentation in Claude Code?
Run `npx skills add samchon/typia --skill documentation -a claude-code`. Or copy the skill folder (.agents/skills/documentation in samchon/typia) into .claude/skills/documentation in your project. Claude Code loads it when a task matches its description.
How do I install Documentation in Codex?
Run `npx skills add samchon/typia --skill documentation -a codex`. Or copy the skill folder (.agents/skills/documentation in samchon/typia) into .agents/skills/documentation in your project. Codex loads it when a task matches its description.
Can I use Documentation 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 samchon/typia --skill documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation, .gemini/skills/documentation, .github/skills/documentation and .opencode/skills/documentation in your project.
What does Documentation need to run?
Going by SKILL.md and its folder, Documentation needs the command-line tools its instructions call (pnpm).
Does Documentation access the network?
SKILL.md names 1 domain. As links in the text: typia.io. This is read from the text; nothing was executed.
Is Documentation 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 Documentation use?
Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Documentation use?
About 1.1k tokens (SKILL.md is roughly 4.5k 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 Documentation?
Skills that share tags, products or a category with Documentation: Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars), Dsh Web Documentation (zhu1090093659/dsh-web, 8.4k stars), Newproject (scunning1975/MixtapeTools, 469 stars) and Sync Public Docs (Caldis/react-zmage, 946 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation?
samchon (a GitHub user) maintains it in samchon/typia, which has 5,935 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 6, 2026.
Source: samchon/typia on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.