FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[DOC] Put documentation for tools: xmake tasks and ai folder · Issue #575 · EngineSquared/EngineSquared · GitHub

[DOC] Put documentation for tools: xmake tasks and ai folder #575

Description

Problem Statement

The documentation for several important xmake build tasks and the ai folder is missing or incomplete. New contributors and users cannot easily understand what these build tools do or how to use them.

Proposed Solution

Add comprehensive documentation for the following:

  1. xmake Build Tasks:

    • format: Code formatting task and how to run it
    • check_leaks: Memory leak detection task, how to run it, and how to interpret results
    • build_documentation: Documentation generation task and output location
  2. AI Folder:

    • Purpose and structure of the ai folder
    • What components it contains
    • How it is used in the project
    • Integration points with the rest of the codebase

Alternative Solutions

  • Update README only — simpler but scattered documentation
  • Create separate docs for each task — more detailed but less discoverable

Use Cases

  • Use case 1: A new contributor runs xmake format without knowing what it does
  • Use case 2: A developer needs to run memory leak checks and finds clear instructions
  • Use case 3: A user wants to understand the architecture and quickly locates documentation about the ai folder

Impact

  • Documentation only — no changes to source code or build system
  • No breaking changes
  • Improves project accessibility and onboarding experience

Implementation Details (optional)

  • Add a docs/build-tasks.md file documenting all xmake tasks
  • Add a docs/ai-folder.md or section in existing architecture docs
  • Link from README to these documentation files
  • Include command examples and expected outputs

Additional Context

Clear documentation for build tools helps prevent confusion and improves the developer experience.

Related Issues

  • N/A

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions


Back | FazBrowse Home | New Git URL