orient

Generate a repo orientation guide documenting structure, languages, and key files.

9|Updated Feb 15, 2026

Search Tags:#documentation #onboarding #codebase #learning #project-structure #orientation

Ready to run

npx skills add https://github.com/gwenwindflower/dotfiles --skill orient-gwenwindflower

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: orient
Source: https://github.com/gwenwindflower/dotfiles/tree/main/dot_agents/exact_skills/orient
Command: npx skills add https://github.com/gwenwindflower/dotfiles --skill orient-gwenwindflower

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates a repo-oriented orientation guide to help new contributors understand a codebase.

Core Features & Use Cases

Writes a structured orientation.md at the project root: <project root>/.agents/docs/orientation.md, containing guidance on repo structure, languages, and key files.
Appends with a suffix if an existing orientation.md is present to avoid overwriting, preserving history.
Provides a ready-to-share onboarding doc that can be committed or ignored as needed.

Quick Start

Invoke the orient skill with /orient:orient to generate orientation.md at <project root>/.agents/docs/orientation.md.

Frequently Asked Questions about orient

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

FAQPage Schema

How do I generate an onboarding guide for a new codebase?▼

To generate an onboarding guide for a new codebase, use a skill that automatically writes a structured orientation document at the project root. It outlines repo structure, languages, key files, and common gotchas to help new contributors understand the project quickly.

What is the best way to help new contributors learn project structure?▼

The best way to help new contributors learn project structure is providing a reusable orientation document outlining workflow and core concepts. An automated guide generation approach creates this documentation by analyzing the repository and writing a concise summary.

How does automatic codebase orientation documentation work?▼

Automatic codebase orientation documentation works by analyzing the repository and writing an orientation markdown file to the project root. It safely appends a suffix if an existing document is present to avoid overwriting and preserve history.

Can I automatically document repo structure without overwriting existing orientation files?▼

Yes, you can automatically document repo structure without overwriting existing orientation files. The generation process safely appends a suffix to the new file name if an orientation document already exists, preserving previous documentation history.

Does repo orientation support guided exercises for new developers?▼

Yes, repo orientation supports guided exercises for new developers. The generated orientation guide includes two guided exercises alongside outlines of repo structure, languages, key files, core concepts, and common gotchas.