Skip to content

feat: update README and commands documentation#194

Merged
dermatz merged 6 commits into
mainfrom
feat/updated-readme
Jun 3, 2026
Merged

feat: update README and commands documentation#194
dermatz merged 6 commits into
mainfrom
feat/updated-readme

Conversation

@dermatz
Copy link
Copy Markdown
Member

@dermatz dermatz commented Jun 3, 2026

This pull request significantly improves MageForge's documentation for both users and contributors. The main changes include a comprehensive rewrite and restructuring of the README.md for clarity and usability, the addition of a detailed commands reference, and updates to advanced usage and custom builder documentation. A special thanks section was also added to acknowledge community contributors.

Documentation Restructuring and Improvements:

  • Major rewrite and reorganization of README.md:
    • Clarifies project description, requirements, and supported theme types.
    • Streamlines installation and quick start instructions.
    • Expands on the Frontend Inspector features and usage.
    • Splits out and references a new Commands Reference document.
    • Improves contributor and support information.
  • Adds a new docs/commands_reference.md file:
    • Provides a comprehensive, structured reference for all MageForge CLI commands, grouped by theme, Hyvä, and system commands.
    • Includes arguments, options, behaviors, and example usage for each command.
  • Updates docs/advanced_usage.md:
    • Removes outdated content and prepares for revised advanced usage documentation.
  • Updates docs/custom_theme_builders.md:
    • Corrects method signatures for build and watch in the PHP example to include the themeCode parameter, ensuring consistency with the actual interface. [1] [2] [3]

Community and Credits:

  • Adds a "Special Thanks" section in README.md to acknowledge the e3n-team for their contributions to MageForge.

Copilot AI review requested due to automatic review settings June 3, 2026 18:22
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 3, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures MageForge’s user-facing documentation by rewriting the root README, replacing the older commands doc with a new commands reference, and updating the custom builder documentation to match current interfaces.

Changes:

  • Rewrote and reorganised README.md (requirements, quick start, inspector overview, doc links, credits).
  • Replaced the previous commands documentation with a new docs/commands_reference.md.
  • Updated the custom theme builder example signatures to include themeCode; removed the previous advanced usage doc.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Reorganises end-user docs and links to the new commands reference (currently includes a broken link + a table formatting issue).
docs/custom_theme_builders.md Updates PHP example method signatures to include themeCode parameter.
docs/commands.md Removes the previous commands documentation file (superseded by the new reference).
docs/commands_reference.md Adds a structured CLI command reference (currently contains an incorrect example theme code).
docs/advanced_usage.md Removes the previous advanced usage document (README still references it).

Comment thread README.md Outdated
Comment thread README.md
Comment thread docs/commands_reference.md Outdated
Copilot AI review requested due to automatic review settings June 3, 2026 18:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Comment thread docs/commands_reference.md
Comment thread docs/commands_reference.md
Comment thread docs/commands_reference.md
Comment thread docs/commands_reference.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 3, 2026 18:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comment thread README.md Outdated
Comment thread docs/custom_theme_builders.md
@dermatz dermatz merged commit 526c456 into main Jun 3, 2026
12 checks passed
@dermatz dermatz deleted the feat/updated-readme branch June 3, 2026 19:02
@github-actions github-actions Bot mentioned this pull request Jun 3, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants