Aholo Viewer Docs
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
Writes and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical English, clear structure, and careful disclosure.
Install Documentation
$ npx skills add surrealdb/docs.surrealdb.com --skill documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install surrealdb/docs.surrealdb.com 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/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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/surrealdb/docs.surrealdb.com/tree/main/.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 surrealdb/docs.surrealdb.com --skill documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install surrealdb/docs.surrealdb.com documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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 surrealdb/docs.surrealdb.com --skill documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install surrealdb/docs.surrealdb.com documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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/surrealdb/docs.surrealdb.com.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 surrealdb/docs.surrealdb.com --skill documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install surrealdb/docs.surrealdb.com documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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 surrealdb/docs.surrealdb.com 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 surrealdb/docs.surrealdb.com --skill documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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 surrealdb/docs.surrealdb.com --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 surrealdb/docs.surrealdb.com documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/surrealdb/docs.surrealdb.com.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/surrealdb/docs.surrealdb.com/tree/main/.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
- 121
- Token cost
- ~2.4k tokens
- SKILL.md length
- 1,106 words
- Files
- 3 (incl. references)
- Skills in repo
- 2
- Repo updated
- First seen
- Licence
- None found
At a glance
Writes and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical English, clear structure, and careful disclosure.
- Works in 6 steps: Audience and disclosure → Page types → Voice, tone, and prose → …
- Documentation is written - including new guides
- SKILL.md covers Modes, Workflow, Output and Examples, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Documentation is an agent skill from surrealdb/docs.surrealdb.com. Writes and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical English, clear structure, and careful disclosure. Use whenever documentation is written - including new guides, quickstarts, reference pages, overviews, how-tos, explanations, README docs, and rewrites of existing doc text for a public audience.
Its SKILL.md is about 2.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/examples.md` and `references/ste.md`).
It sits in Databases, covering Technical writing and Vector databases. It works with SurrealDB, OpenAPI and Astro. The repository describes itself as: The documentation for SurrealDB, built with Vike, React, and Mantine.
When your agent uses it
- Documentation is written - including new guides
- Reference pages
- Rewrites of existing doc text for a public audience
Example prompts
- “Use the documentation skill to write and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical…”
- “/documentation”
Workflow steps
6 steps, taken from the step headings in SKILL.md.
- Audience and disclosure
- Page types
- Voice, tone, and prose
- Structure and formatting
- Public-safety pass
- Final read
What it can do on your machine
Read from SKILL.md and the folder at commit a3e9433. 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
Documentation loads about 2.4k tokens when it runs, and up to ~4.5k if it reads all its reference files. Until then it costs about 94 tokens; SKILL.md has 1,106 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
Without a licence we can't republish the file, so here is its outline and opening line. It has 1,106 words (~2,433 tokens).
“Write public product documentation that a new or moderately experienced reader can follow without guesswork, marketing filler, or internal leakage.”
- name
- documentation
- metadata.author
- surrealdb
- metadata.version
- 0.1.0
Files
SKILL.md and 2 other files (references) in .agents/skills/documentation of surrealdb/docs.surrealdb.com.
- SKILL.md
- references/examples.md
- references/ste.md
Open the folder on GitHubat commit a3e9433
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 skillsurrealdb/docs.surrealdb.com | 121 | — | ~2.4k | Automated safety check: Pass | None | |
| Aholo Viewer Docsmanycoretech/aholo-viewer | 1.1k | — | ~341 | Automated safety check: Pass | MIT | |
| DocsInsForge/InsForge | 13k | — | ~761 | Automated safety check: Pass | Apache-2.0 | |
| Doc Writermicrosoft/aspire.dev | 196 | — | ~7.6k | Automated safety check: Pass | MIT | |
| Docs Interfacesjh941213/my-cc-harness | 126 | — | ~863 | Automated safety check: Notes | None | |
| Aliyun Platform Docs Reviewcinience/alicloud-skills | 397 | — | ~630 | Automated safety check: Pass | MIT |
Similar skills
Docs
InsForge/InsForge
A skill your agent uses when contributing to InsForge's product documentation in this repository.
- Official
Doc Writer
microsoft/aspire.dev
Guidelines for producing accurate and maintainable documentation for the Aspire documentation site.
Docs Interfaces
jh941213/my-cc-harness
Generate interface/API docs — OpenAPI 3.1/AsyncAPI 3.0 specs, API topology diagrams, interface flow (sequence) diagrams, API changelog.
Aliyun Platform Docs Review
cinience/alicloud-skills
A skill your agent uses when reviewing latest Alibaba Cloud product docs and OpenAPI docs by product name, then output detailed prioritized improvement suggestions with evidence and scoring.
Sap Hana CLI
secondsky/sap-skills
Assists with SAP HANA Developer CLI (hana-cli) for database development and administration.
More from surrealdb/docs.surrealdb.com
Web Accessibility
surrealdb/docs.surrealdb.com
Implement web accessibility (a11y) standards following WCAG 2.1 guidelines.
Related
Questions about Documentation
What does Documentation do?
Writes and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical English, clear structure, and careful disclosure. com. Writes and rewrites public-facing product documentation with a semi-technical tone, ASD-STE100 Simplified Technical English, clear structure, and careful disclosure.
When should I use Documentation?
Documentation fits situations like: documentation is written - including new guides; reference pages; rewrites of existing doc text for a public audience.
How do I install Documentation in Claude Code?
Run `npx skills add surrealdb/docs.surrealdb.com --skill documentation -a claude-code`. Or copy the skill folder (.agents/skills/documentation in surrealdb/docs.surrealdb.com) 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 surrealdb/docs.surrealdb.com --skill documentation -a codex`. Or copy the skill folder (.agents/skills/documentation in surrealdb/docs.surrealdb.com) 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 surrealdb/docs.surrealdb.com --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?
SKILL.md names no scripts, command-line tools or credentials: Documentation is instructions for the agent only.
Does Documentation 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 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?
No licence was found for Documentation or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.
How many tokens does Documentation use?
About 2.4k tokens (SKILL.md is roughly 9.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.1k tokens, read only when the agent opens those files.
What are the alternatives to Documentation?
Skills that share tags, products or a category with Documentation: Aholo Viewer Docs (manycoretech/aholo-viewer, 1.1k stars), Docs (InsForge/InsForge, 13k stars), Doc Writer (microsoft/aspire.dev, 196 stars) and Docs Interfaces (jh941213/my-cc-harness, 126 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation?
surrealdb (a GitHub organization) maintains it in surrealdb/docs.surrealdb.com, which has 121 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 8, 2026.
Source: surrealdb/docs.surrealdb.com on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.