skills.rest
Andreicr1
Andreicr1COMMUNITY
Explore all skills by this author →
GitHub

onboarding

Generate ONBOARDING.md at the repository root from inventory scanning.

Updated Mar 14, 2026
Search Tags:#automation#documentation#onboarding#codebase#repository#contributing#inventory
One-click install
npx skills add https://github.com/Andreicr1/netz-analysis-engine --skill onboarding-andreicr1
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboarding
Source: https://github.com/Andreicr1/netz-analysis-engine/tree/main/.gemini/skills/onboarding
Command: npx skills add https://github.com/Andreicr1/netz-analysis-engine --skill onboarding-andreicr1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ONBOARDING documents are often missing or out of date. This skill automatically generates ONBOARDING.md at the repo root by inspecting the repository inventory and existing docs, giving newcomers a clear mental model of the codebase.

Core Features & Use Cases

  • Inventory-driven generation analyzes languages, entry points, docs, and scripts.
  • Phase-driven workflow outlines the core process: inventory gathering, essential file reading, and document writing.
  • Safe and reproducible: regenerates from the current repo state without diffing prior versions.

Quick Start

Run the onboarding generator to create ONBOARDING.md at the repository root.

Frequently Asked Questions about onboarding

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

FAQPage Schema
How do I auto-generate onboarding documentation for a new codebase contributor?▼

To auto-generate onboarding documentation, run the onboarding generator to crawl your repository and create an ONBOARDING.md file at the root. It inspects the inventory, entry points, and scripts to provide a living codebase overview for new contributors.

What is the best way to keep contributor setup guides updated as the repository changes?▼

Keeping contributor setup guides updated is best handled by regenerating the ONBOARDING.md document from the current repository state. The tool safely rewrites onboarding content deterministically without diffing prior versions, ensuring actionable setup steps reflect recent changes.

Does the onboarding generator require external dependencies or access to secrets?▼

No, the onboarding generator avoids secrets and external dependencies entirely. It relies solely on local repository inventory scanning and selective file reading to produce the ONBOARDING.md document, ensuring safe and reproducible execution within your environment.

How does inventory scanning work when generating repository onboarding files?▼

Inventory scanning works by analyzing your repository's languages, entry points, existing docs, and scripts. This phase-driven workflow gathers essential file data to deterministically rewrite the ONBOARDING.md content, giving newcomers a clear mental model of the codebase structure.

Can I use this tool to create an ONBOARDING.md file for any repository?▼

Yes, you can use this tool to create an ONBOARDING.md file for any repository. It performs an inventory-driven generation process that analyzes the codebase and writes the document at the root, guiding new contributors with actionable setup steps regardless of the project scale.

Why does the generated onboarding document overwrite the previous version instead of diffing?▼

The generated onboarding document overwrites the previous version to ensure a safe and reproducible result from the current repo state. Avoiding diffs from prior versions guarantees the contributor guidance accurately reflects the latest codebase inventory without manual merge conflicts.

Related Skills

Explore More Software Engineering Skills→
mohamedgshoaibmohamedgshoaib
5

write-project-readme

Generates README files from scanned repository contents and metadata.

Community
Intermediate
Delphine-LDelphine-L
17

folder-organization

Standardizes project folder structures with naming conventions and version-control-friendly layouts.

Community
Basic
SSujitXSSujitX
11

Release Process

Automate semantic versioning and releases via conventional commits and GitHub Actions.

Community
Advanced
belokonmbelokonm
8

technical-writer

Generate API references, user guides, tutorials, and knowledge base documentation.

Community
Intermediate