skills.rest
kreuzberg-dev
kreuzberg-devOFFICIAL
Explore all skills by this author →
WebsiteGitHub

Project Structure & Conventions

Document the directory structure and coding conventions for the html-to-markdown project.

836|66|Updated Feb 3, 2025
Search Tags:#project structure#conventions#developer guide#html-to-markdown#repository layout
One-click install
npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill project-structure-conventions-kreuzberg-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Project Structure & Conventions
Source: https://github.com/kreuzberg-dev/html-to-markdown/tree/main/.remote-cache/kreuzberg-shared-rules/.ai-rulez/skills/project-structure
Command: npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill project-structure-conventions-kreuzberg-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps users understand the organizational structure and established conventions of the html-to-markdown project, facilitating easier navigation and contribution.

Core Features & Use Cases

  • Project Overview: Provides a clear, hierarchical view of the project's directories and their purposes.
  • Convention Guidance: Outlines the expected structure for different components like crates, packages, examples, and CI workflows.
  • Use Case: A new developer joining the project can quickly grasp where to find the core Rust library, the various language bindings, example implementations, and the CI/CD configurations.

Quick Start

Explain the purpose of the crates/html-to-markdown/ directory within the project structure.

Frequently Asked Questions about Project Structure & Conventions

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

FAQPage Schema
What is the directory structure of the html-to-markdown project?▼

The html-to-markdown project structure organizes the core Rust library in the crates directory, separates language bindings, places examples in a dedicated folder, and configures CI workflows. It provides a hierarchical layout that clarifies module organization for developers.

How do I navigate the html-to-markdown repository layout to find the core library?▼

To find the core library, navigate to the crates/html-to-markdown/ directory within the repository layout. This directory contains the primary Rust library implementation for the project.

Where are the coding conventions and CI workflows defined for the html-to-markdown project?▼

Coding conventions and CI workflows are defined in dedicated configuration directories within the repository. The project outlines expected structures for components, examples, and CI practices to guide development.

Does the html-to-markdown project include specific guidelines for language bindings and examples?▼

Yes, the project includes specific convention guidance for language bindings and example implementations. Developers can find these components organized in distinct directories to understand their purposes and expected structures.

What is the purpose of the crates directory in a Rust project structure?▼

The crates directory in a Rust project structure houses the core libraries and packages. In the html-to-markdown project, it contains the primary library implementation essential for the conversion functionality.

Related Skills

Explore More Software Engineering Skills→
yocxy2yocxy2

context-restore

Restore session context and workspace state for multi-session engineering tasks.

Community
Intermediate
spiriMirrorspiriMirror
307

run-tests

Run Catch2 C++ and pytest Python tests to validate code correctness.

Official
Intermediate
TTAWDTTTTAWDTT
4

project-bootstrapper

Generate project structure, tooling, and documentation for new or existing repositories.

Community
Advanced
akin-ozerakin-ozer
290

makefile-generator

Generate Makefiles for multi-language projects with GNU targets.

Community
Basic