-
Notifications
You must be signed in to change notification settings - Fork 0
Refresh GoalOS / Proof Gradient README, docs, figures, tables, badges, and validation #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MontrealAI
wants to merge
1
commit into
main
Choose a base branch
from
codex/refresh-documentation-and-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Validate GoalOS Catalog | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'README.md' | ||
| - 'docs/**' | ||
| - 'site/**' | ||
| - 'scripts/**' | ||
| - '.github/workflows/validate-goalos-catalog.yml' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| validate: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out repository | ||
| uses: actions/checkout@v4 | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.11' | ||
| - name: Validate GoalOS catalog consistency | ||
| run: python scripts/validate_goalos_catalog.py | ||
| - name: Validate public site v14 rules | ||
| run: python scripts/validate_goalos_public_site.py |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,39 @@ | ||
| # Contributing | ||
| # Contributing to Proof Gradient · GoalOS | ||
|
|
||
| Thank you for improving Agent SkillOS. | ||
| Thank you for improving the public proof and standards layer. | ||
|
|
||
| ## Local setup | ||
| ## Documentation update rules | ||
|
|
||
| ```bash | ||
| python -m skillos.cli demo | ||
| python -m unittest discover -s tests | ||
| ``` | ||
| - Keep `docs/data/goalos_catalog.yml` as the source of truth for product names, prices, versions, public status, standards, validation status, and safe claim boundaries. | ||
| - When the product ladder changes, update the catalog, `docs/tables/goalos_product_ladder.csv`, README, and relevant GoalOS docs in the same pull request. | ||
| - When figures change, update both Mermaid source (`docs/figures/*.mmd`) and SVG export (`docs/figures/*.svg`) when practical. | ||
| - When tables change, update CSV files under `docs/tables/` first and keep Markdown tables consistent. | ||
|
|
||
| ## Paid-file policy | ||
|
|
||
| Do not commit paid buyer ZIPs, workshop bundles, delivery kits, implementation bundles, enterprise pilot bundles, professional-firm packs, or private commercial artifacts to public deploy roots. All paid product purchase/application links must point to: | ||
|
|
||
| <https://www.quebecartificialintelligence.com/shop> | ||
|
|
||
| ## Claim boundary | ||
|
|
||
| ## Development principles | ||
| Do not add unsupported claims of guaranteed ROI, guaranteed revenue, guaranteed productivity, investment returns, legal/financial/tax advice, compliance certification, AI safety certification, autonomous AGI, base-model self-modification, uncontrolled autonomous deployment, achieved AGI/ASI, or independently unproven real profit/revenue. | ||
|
|
||
| 1. Keep the core loop easy to understand. | ||
| 2. Prefer small, inspectable skill artifacts over opaque behavior. | ||
| 3. Every new skill update path needs tests. | ||
| 4. Every release path needs rollback. | ||
| 5. Do not mix private knowledge with shared skill. | ||
| ## Validation commands | ||
|
|
||
| ## Pull request checklist | ||
| Run before opening a PR: | ||
|
|
||
| - [ ] Tests pass. | ||
| - [ ] New behavior is documented. | ||
| - [ ] New skill behavior is versioned. | ||
| - [ ] Permission changes are explicit. | ||
| - [ ] No local `.skillos` data is committed. | ||
| ```bash | ||
| python scripts/check_no_paid_artifacts.py | ||
| python scripts/validate_goalos_public_site.py | ||
| python scripts/validate_docs_tables_figures.py | ||
| python scripts/validate_goalos_catalog.py | ||
| ``` | ||
|
|
||
| If available, also run: | ||
|
|
||
| ```bash | ||
| pytest | ||
| make test | ||
| node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,30 @@ | ||
| # QA verification | ||
| # QA Verification | ||
|
|
||
| This package was verified locally before delivery. | ||
|
|
||
| Commands run: | ||
| ## Required GoalOS validation commands | ||
|
|
||
| ```bash | ||
| PYTHONDONTWRITEBYTECODE=1 python scripts/qa_check.py | ||
| python -m skillos.cli wealth-proof | ||
| node --check site/app.js | ||
| python scripts/check_no_paid_artifacts.py | ||
| python scripts/validate_goalos_public_site.py | ||
| python scripts/validate_docs_tables_figures.py | ||
| python scripts/validate_goalos_catalog.py | ||
| ``` | ||
|
|
||
| Expected result: | ||
|
|
||
| ```text | ||
| ✅ Repository file verification passed | ||
| Ran 6 tests ... OK | ||
| ✅ Agent SkillOS verification passed | ||
| ✅ Verified GitHub Pages output at dist | ||
| ✅ Repository QA passed | ||
| ``` | ||
|
|
||
| What is checked: | ||
|
|
||
| - End-to-end SkillOS loop: Work → Trace → Learn → Skill → Test → Release. | ||
| - SQLite storage initialization. | ||
| - GitHub Pages demo snapshot generation. | ||
| - reference workflow proof generation at `data/wealth_proof.json` and `dist/data/wealth_proof.json`. | ||
| - Monotonic economic checks: every release decreases cost, decreases minutes, increases quality, and increases accepted rate. | ||
| - `dist/index.html`, `dist/styles.css`, `dist/app.js`, `dist/data/demo.json`, `dist/data/wealth_proof.json`, `.nojekyll`, and manifest creation. | ||
| - Repository targets `MontrealAI/proof-gradient` and `https://montrealai.github.io/proof-gradient/`. | ||
| - JavaScript syntax for the static website. | ||
| - Root-level fallback website mirror is included for branch-root GitHub Pages deployment. | ||
| ## Current validation baseline | ||
|
|
||
| GitHub Actions re-runs the same QA path during deployment. | ||
| - Current: GoalOS Validation Hotfix v14 Microsite Compatibility. | ||
| - Obsolete as current references: v12, v13, and obsolete v8 compatibility validation. | ||
| - Canonical pages require one canonical shell and footer. | ||
| - Standalone proof/microsite pages may use standalone metadata and a visible `/proof-gradient/` escape link. | ||
| - App pages may use app shell. | ||
| - Public AEP packages are allowed only at `standards/AEP-###/complete-package.zip`. | ||
| - Paid/private artifacts are blocked from public deploy roots. | ||
|
|
||
| ## v3.0 reference workflow proof | ||
| ## Optional tests when tooling is available | ||
|
|
||
| This repository includes `scripts/prove_wealth_loop.py`, `skillos/wealth_proof.py`, `tests/test_wealth_proof.py`, and `data/wealth_proof.json`. | ||
|
|
||
| The proof uses the sales follow-up workflow to verify that each completed job creates a tested release and that the workflow gets cheaper, faster, and better after every release. | ||
|
|
||
| Current proof result: | ||
|
|
||
| ```text | ||
| Workflow: Sales follow-up email from call notes | ||
| Final skill version: v6 | ||
| Quality: 0.50 → 0.96 | ||
| Minutes/job: 6.75 → 2.55 | ||
| Cost/job: $8.48 → $3.23 | ||
| projected annual savings under demo assumptions vs human baseline at 10,000 jobs: $117,700 | ||
| ```bash | ||
| pytest | ||
| make test | ||
| node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs | ||
| ``` | ||
|
|
||
| The GitHub Pages deploy refuses to publish if the reference workflow proof fails. | ||
| If a tool is unavailable, document the skip in `docs/GOALOS_REPO_AUDIT.md`. |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this GitHub Actions job, no step installs the repo's dev dependencies before checking
find_spec('pytest'), andpytestis only declared under optional dev dependencies inpyproject.toml. On a cleansetup-pythonrunner this branch exits 0, so the newly extendedtests/test_goalos_public_site_rules.pyregression coverage is silently skipped and future changes to the paid/private artifact classifier will not be caught by this workflow.Useful? React with 👍 / 👎.