openbridge-webcomponents docgen.instructions.md

openbridge-webcomponents docgen.instructions.md is an instructions file for GitHub Copilot from Ocean-Industries-Concept-Lab/openbridge-webcomponents. It costs 401 tokens per session, scanned A, original, Apache-2.0.

A command-line tool that drafts JSDoc comments for TypeScript source files, using the source file’s stories and CSS to choose a documentation pattern. It writes a separate review copy and leaves the original unchanged.

In plain words
What is it for?
Use it to generate documentation drafts for components, ordinary function modules, and abstract base classes. Review the generated file, then copy approved changes into the source manually.
Why use it?
It gives developers a starting draft while keeping generated changes easy to compare, review, and merge. It also keeps the draft aligned with the project’s JSDoc rules.

Instructions file for GitHub Copilot

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 instructions/ocean-industries-concept-lab/openbridge-webcomponents/docgen
Clone the repo
git clone --depth 1 https://github.com/Ocean-Industries-Concept-Lab/openbridge-webcomponents

Made for: GitHub Copilot.

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 openbridge-webcomponents docgen.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ocean-industries-concept-lab/openbridge-webcomponents/docgen.svg)](https://agentmods.dev/instructions/ocean-industries-concept-lab/openbridge-webcomponents/docgen)
Your own site
<a href="https://agentmods.dev/instructions/ocean-industries-concept-lab/openbridge-webcomponents/docgen"><img src="https://agentmods.dev/badge/instructions/ocean-industries-concept-lab/openbridge-webcomponents/docgen.svg" alt="Measured on agentmods" height="20"></a>
Per session 401 This file is loaded in full into every session.
When invoked 401 The same file — it is already loaded in full.
Security scan A 0 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 $0.00401 $0.00401
Opus 5 $0.00200 $0.00200
Sonnet 5 $0.00080 $0.00080
Haiku 4.5 $0.00040 $0.00040

Measured 5d ago against content hash b5fd819b1e6d, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openbridge-webcomponents docgen.instructions.md scanned grade A with 0 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 5d ago.

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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/docgen.instructions.md · 42 lines

What it actually says

Doc Generator CLI

script/docgen/ is a small CLI that drafts JSDoc for a source file using an OpenAI model.

File Role
docs-gen.ts The CLI itself
prompt-system.txt The shared system prompt
README.md Setup, dependencies and usage

It reads the .ts plus its sibling .stories.ts and .css, auto-detects which of the three documentation patterns applies (concrete component, pure function module, abstract base class), and writes a *.generated.ts review copy next to the original.

It never edits the original

The review-copy design is the point: output is a draft for a human to diff and merge, not a change. Do not wire this into a build step, a lint rule, or a pre-commit hook, and do not commit *.generated.ts files.

Keep the prompt aligned with the rules

prompt-system.txt encodes the same conventions as jsdoc.md — the section order, the tone rule that forbids domain qualifiers, the TODO(designer) placeholder, and the structured @slot / @fires tag block.

When the JSDoc rules change, update the prompt too. Nothing enforces the link, so a rule added to jsdoc.md alone will be silently contradicted by every subsequent draft. Generated output still has to pass npm run lint:slots like any hand-written JSDoc.

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. 5d ago First seen · 42 lines · 401 tokens per session scan A b5fd819b1e6d

Subscribe to this mod's changes

openbridge-webcomponents docgen.instructions.md is an instructions file published in the GitHub repository Ocean-Industries-Concept-Lab/openbridge-webcomponents (91 stars, last pushed yesterday), licensed Apache-2.0. It adds 401 tokens to every session, about $0.0020 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.