igniter-js writing-guidelines.instructions.md

igniter-js writing-guidelines.instructions.md is an instructions file for GitHub Copilot from felipebarcelospro/igniter-js. It costs 6,725 tokens per session, scanned C, original, Apache-2.0.

A writing guide for Igniter.js documentation aimed at both people and AI tools. It defines preferred language, structure, examples, and use of the project's documentation components.

In plain words
What is it for?
Use it when writing or reviewing Igniter.js blog posts, guides, templates, and updates.
Why use it?
It reduces inconsistent or overly technical documentation by giving authors shared rules and examples.

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/felipebarcelospro/igniter-js/writing-guidelines
Clone the repo
git clone --depth 1 https://github.com/felipebarcelospro/igniter-js

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 igniter-js writing-guidelines.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/felipebarcelospro/igniter-js/writing-guidelines.svg)](https://agentmods.dev/instructions/felipebarcelospro/igniter-js/writing-guidelines)
Your own site
<a href="https://agentmods.dev/instructions/felipebarcelospro/igniter-js/writing-guidelines"><img src="https://agentmods.dev/badge/instructions/felipebarcelospro/igniter-js/writing-guidelines.svg" alt="Measured on agentmods" height="20"></a>
Per session 6,725 This file is loaded in full into every session.
When invoked 6,725 The same file — it is already loaded in full.
Security scan C 1 finding. 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.06725 $0.06725
Opus 5 $0.03363 $0.03363
Sonnet 5 $0.01345 $0.01345
Haiku 4.5 $0.00673 $0.00673

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

Security

Grade C, and why

igniter-js writing-guidelines.instructions.md scanned grade C with 1 finding 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 3d 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.

Hidden instructionshighPrompt injection

Directives inside HTML comments, invisible characters or bidirectional overrides are read by the model and not by the person reviewing the file.

<!-- Detailed instructions -->
.github/instructions/writing-guidelines.instructions.md · 1,037 lines

How it starts

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

Writing Guidelines for Humans and LLMs

This guide ensures consistent, high-quality documentation across all Igniter.js content types (blog, docs, templates, updates). It's designed for both human authors and AI agents to produce excellent developer experiences.

Core Style Principles

Principle Definition Example: Good Example: Bad
Clear Language Use simple, direct language with short words and sentences. Avoid unnecessary jargon. "Click save to store your changes." "Initiate the persistence process by activating the storage mechanism."
Developer-Focused Write in a professional but approachable tone that addresses the reader directly. "You can configure this option in the settings panel." "Users might want to adjust configuration parameters."
Example-Driven Include practical code examples for all key concepts. "Use the useState hook: const [count, setCount] useState(0)" "State management is an important React concept."
Active Voice Make the subject perform the action rather than receive it. "React renders the component." "The component is rendered by React."
Success-First Show working examples before explaining theory. "First, create a component: function Button() {...}. Now let's understand how it works..." "The component lifecycle has several phases which you must understand before implementation..."
Transparent Be honest about limitations and challenges. "This approach works well for small datasets but may cause performance issues with larger ones." "This is the optimal solution for data management."
Consistent Terms Use the same terminology throughout to refer to the same concepts. "Route" consistently or "endpoint" consistently, not both interchangeably. Mixing "callback function" and "handler" for the same concept.

Fumadocs-Specific Guidelines

Igniter.js documentation uses Fumadocs, a modern documentation framework with MDX support and powerful components.

Read the full file on GitHub · 1,037 lines

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. 3d ago First seen · 1,037 lines · 6,725 tokens per session scan C 0681e3908da1

Subscribe to this mod's changes

igniter-js writing-guidelines.instructions.md is an instructions file published in the GitHub repository felipebarcelospro/igniter-js (242 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 6,725 tokens to every session, about $0.0336 per session on Opus 5. A static security scan graded it C with 1 finding (hidden instructions). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-01.