Repository navigation
Document the module manifest, icon convention, and dev tooling - #105
Merged
Merged
Conversation
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
1 issue found across 3 files
Reply with feedback, questions, or to request a fix.
Turn on auto-fix | Re-trigger cubic
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="src/content/docs/getting-started/building.mdoc">
<violation number="1" location="src/content/docs/getting-started/building.mdoc:61">
P2: This section doesn't mention the PHP requirement. The `tools/` package needs PHP 8.5 (`tools/composer.json` sets `~8.5.0`), but the Prerequisites above say PHP 8.3 or newer, so `composer install --working-dir=tools` fails on 8.3 and 8.4. Add the PHP 8.5 requirement to this section.</violation>
</file>
Deploying Preview to CloudflarePreview URL: https://manifest-and-tooling-docs-docs.fossbilling.workers.dev/ (commit
|
| Status | Deployment URL | Commit | Updated (UTC) | Details |
|---|---|---|---|---|
| Build: Success ✅ Deployment: Success ✅ |
https://414ecf49-docs.fossbilling.workers.dev/ | d9a7022 |
2026-11-10T02:33:16.896Z | View logs ↗ |
| Build: Success ✅ Deployment: Success ✅ |
https://b69a23d9-docs.fossbilling.workers.dev/ | 51217c1 |
2026-11-10T02:28:23.316Z | View logs ↗ |
The module manifest had no field documentation: the file-structure page named the file and the creating-a-module guide said to update it. Add a manifest section with the required and optional fields, the shipped icon convention (icon.svg/png/webp/avif at the module root, at most one), and a link to the canonical schema in FOSSBilling/modules. Also add the icon file to the module filetree, and a developer tooling section to the building page covering the tools/ console package.
admdly
force-pushed
the
manifest-and-tooling-docs
branch
from
November 10, 2026 02:31
51217c1 to
d9a7022
Compare
Contributor
There was a problem hiding this comment.
0 issues found across 1 file (changes from recent commits).
Auto-approved: Documentation-only additions covering the module manifest spec, icon file convention, and developer tooling commands. No runtime behavior changes; the change is bounded to docs and clearly beneficial.
Turn on auto-fix | Re-trigger cubic
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.
Three additive documentation changes, bringing the docs in line with the module manifest ecosystem changes that landed in
FOSSBilling/modules#15andFOSSBilling/FOSSBilling#4662/#4668:creating-a-module.mdoc— new "The Manifest" section: the required fields (matchingmanifest.schema.json'srequiredlist), the optionalhomepage_url, the shipped icon convention (icon.svg/icon.png/icon.webp/icon.avifat the module root, at most one, no manifest entry), and a link to the canonical schema inFOSSBilling/modules— kept as the single source of truth rather than duplicating the spec here.file-structure.mdoc— the optional icon file added to the module filetree.building.mdoc— new "Developer Tooling" section covering thetools/console package (install,list, and themanifest:validate/i18n:*/demo:seedcommands), which previously had no docs presence.