documentation-website-for-software-project

documentation-website-for-software-project is a skill for Claude Code, Codex from hachej/boring-ui. It costs 46 tokens per session (5,517 once invoked), scanned C, original, MIT.

A workflow for turning a software repository into a documentation website using Nextra, a documentation framework for Next.js. It creates written explanations and reference pages from the repository.

In plain words
What is it for?
Use it to create MDX documentation, navigation, search, dark mode, diagrams, mathematical notation, edit links, and a deployable site for a project.
Why use it?
It removes the need to design and assemble a documentation site, organize its content, and add common documentation features from scratch.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions subagents; installed under .agents/ (shared by several agents); mentions AGENTS.md.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/hachej/boring-ui/documentation-website-for-software-project
Any agent
npx skills add hachej/boring-ui --skill documentation-website-for-software-project
Clone the repo
git clone --depth 1 https://github.com/hachej/boring-ui

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-website-for-software-project

README.md
[![agentmods](https://agentmods.dev/badge/skills/hachej/boring-ui/documentation-website-for-software-project.svg)](https://agentmods.dev/skills/hachej/boring-ui/documentation-website-for-software-project)
Your own site
<a href="https://agentmods.dev/skills/hachej/boring-ui/documentation-website-for-software-project"><img src="https://agentmods.dev/badge/skills/hachej/boring-ui/documentation-website-for-software-project.svg" alt="Measured on agentmods" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 5,517 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 2 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00046 $0.05517
Opus 5 $0.00023 $0.02759
Sonnet 5 $0.00009 $0.01103
Haiku 4.5 $0.00005 $0.00552

Measured 6d ago against content hash 6f73f6188b10, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade C, and why

documentation-website-for-software-project scanned grade C with 2 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

The scan reads SKILL.md. This mod also ships 12 executable files (scripts/a11y-check.sh, scripts/audit-content.mjs, scripts/check-skills.sh, …), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

4. **Package manager?** Prefer `bun` if available. If missing, offer to install via `curl -fsSL https://bun.sh/install | bash` (ask first). Fall back to `pnpm` or `npm`.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

4. **Package manager?** Prefer `bun` if available. If missing, offer to install via `curl -fsSL https://bun.sh/install | bash` (ask first). Fall back to `pnpm` or `npm`.
.agents/skill-library/documentation-website-for-software-project/SKILL.md · 377 lines

How it starts

The opening of the file, as written. The whole thing — 377 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Website For Software Project

The One Rule: Documentation is narrative plus reference, not a method dump. Before typing any MDX, build a mental model of the codebase; write prose that explains why and how it fits; only then drop into parameter tables.


What This Skill Produces

A deployable Nextra 4 (App Router) documentation site in a sibling directory <project>__nextra_documentation_site/, optionally deployed to Vercel. Drafted by parallel subagents across 10 phases, polished until agents stop making substantive changes.

Inputs

  • Source repo path (e.g. /data/projects/frankensqlite), or
  • Git URL (clone into /tmp/ first, then treat as path), or
  • Current working directory if nothing specified.

Outputs

  • <repo>__nextra_documentation_site/ — initialized Nextra project
  • content/ tree populated with narrative MDX (App Router content/ convention)
  • Theme-polished Navbar / Footer / Banner, working search, mermaid + KaTeX, dark mode, edit link, OG image generation
  • Vercel deploy with gh integration, or self-host via bun start / next start
  • Playwright smoke-test run against the deployed URL

Up-Front User Confirmations (Ask Before Starting)

  1. Target project path? Confirm absolute path or clone URL.
  2. Site directory name? Default: <basename>__nextra_documentation_site as a sibling. Confirm OK to create & git init.
  3. Deploy target? Vercel (recommended; works on free tier for internal docs) or self-hosted via bun. If Vercel — do they have an account + CLI? If not, walk them through setup (see DEPLOY.md).
  4. Package manager? Prefer bun if available. If missing, offer to install via curl -fsSL https://bun.sh/install | bash (ask first). Fall back to pnpm or npm.
  5. Fresh run or resuming? If the site directory already exists, confirm whether to re-enter the phase loop (idempotent) or treat as new.

Read the full file on GitHub · 377 lines

Files

What ships with it

59 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 377 lines · 46 tokens per session scan C 6f73f6188b10

Subscribe to this mod's changes

documentation-website-for-software-project is a skill published in the GitHub repository hachej/boring-ui (46 stars, last pushed today), licensed MIT. It adds 46 tokens to every session and 5,517 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it C with 2 findings (downloads and executes remote code, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens