repo-guideline-site

Generate guideline site plans from repository inventories with structured page bundles.

3|Updated Jan 14, 2014
One-click install
npx skills add https://github.com/prateek/dotfiles --skill repo-guideline-site
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-guideline-site
Source: https://github.com/prateek/dotfiles/tree/main/.agents/skills/repo-guideline-site
Command: npx skills add https://github.com/prateek/dotfiles --skill repo-guideline-site

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Repo-to-guideline conversion is typically manual, inconsistent, and hard to scale across teams. This skill provides a structured approach to transform a repository into a polished, audience-aware workflow site with task-oriented onboarding, proof-driven demos, and an explicit evaluation plan.

Core Features & Use Cases

  • Plan bundling and discovery: Inventory the repository, classify audiences, and map a narrative site structure.
  • Narrative-first architecture: Separate homepage, getting started, core workflows, and reference content from the raw repo layout.
  • Proof-driven media pipeline: Define a deterministic media plan with validation gates and reviewer notes.
  • Visual direction and writing: Capture a deliberate design direction and audience-adapted writing guidelines.

Quick Start

Run the repo-site inventory to generate a plan bundle and start the guideline site.

Frequently Asked Questions about repo-guideline-site

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I turn a repository into a guideline site for technical onboarding?

To turn a repository into a guideline site, inventory the repo to classify audiences and map a narrative structure, generating a plan bundle for task-oriented onboarding, proof artifacts, and evaluation plans.

What is the best way to structure documentation for mixed technical audiences and CLI tools?

Structuring documentation for mixed technical audiences requires a narrative-first architecture that separates homepage, getting started, core workflows, and reference content from the raw repository layout.

How do I create a proof-driven media pipeline for an operator workflow site?

Create a proof-driven media pipeline by defining a deterministic media plan with validation gates and reviewer notes, ensuring operator workflow sites feature validated proof artifacts.

Can I generate audience-adapted writing guidelines and visual direction from a repo?

Yes, you can generate audience-adapted writing guidelines and visual direction from a repo by capturing a deliberate design direction tailored to your specific technical readers during the site planning process.

Does generating a workflow site from a repo require manual narrative mapping?

Generating a workflow site from a repo replaces manual narrative mapping with a structured approach that automates inventory, audience classification, and site structure generation into a comprehensive plan bundle.

When should I not use a narrative-first architecture for repo documentation?

Avoid a narrative-first architecture for repo documentation when audiences need direct code access rather than task-oriented onboarding, or when proof artifacts and evaluation plans are unnecessary for the workflow.