Skip to content

Conversation

@httpdss
Copy link
Owner

@httpdss httpdss commented Jun 29, 2025

Issue

Description

This PR enhances the documentation by providing comprehensive guidelines for creating .struct.yaml files. The main feature is the update to the docs, which now include:

  • Detailed instructions for defining structures, folders, and variables
  • Examples for file and folder definitions
  • Important notes and conventions for using the STRUCT tool
  • References to the STRUCT schema, README, and available contribs

These improvements make it easier for users to understand and correctly use the STRUCT tool for project scaffolding.

Checklist

  • I have read the contributing guidelines.
  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have updated the documentation accordingly.

Screenshots (if applicable)

Additional Comments

  • The main feature is the improved documentation for .struct.yaml file generation.

@httpdss httpdss self-assigned this Jun 30, 2025
@httpdss httpdss added documentation Improvements or additions to documentation patch labels Jun 30, 2025
@httpdss httpdss moved this to In Progress in struct-mainboard Jun 30, 2025
@httpdss httpdss marked this pull request as ready for review June 30, 2025 19:42
@httpdss httpdss merged commit ee6537a into main Jun 30, 2025
3 checks passed
@httpdss httpdss deleted the update-docs branch June 30, 2025 19:42
@github-project-automation github-project-automation bot moved this from In Progress to Done in struct-mainboard Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation patch

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants