feat: update README and commands documentation#194
Merged
Conversation
Contributor
There was a problem hiding this comment.
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). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdfor 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:
README.md:docs/commands_reference.mdfile:docs/advanced_usage.md:docs/custom_theme_builders.md:buildandwatchin the PHP example to include thethemeCodeparameter, ensuring consistency with the actual interface. [1] [2] [3]Community and Credits:
README.mdto acknowledge the e3n-team for their contributions to MageForge.