Skip to content

Refresh GoalOS / Proof Gradient README, docs, figures, tables, badges, and validation#19

Open
MontrealAI wants to merge 2 commits into
mainfrom
codex/refresh-goalos-/-proof-gradient-documentation
Open

Refresh GoalOS / Proof Gradient README, docs, figures, tables, badges, and validation#19
MontrealAI wants to merge 2 commits into
mainfrom
codex/refresh-goalos-/-proof-gradient-documentation

Conversation

@MontrealAI

Copy link
Copy Markdown
Owner

Motivation

  • Make the repository a clear, institutional public foundation for Proof Gradient · GoalOS with a single source of truth for product, docs, figures, tables, badges, and validation state.
  • Preserve the public-safe boundary (no paid buyer deliverables) and document the autonomous GitHub Actions release/validation path (v14 + v8 release).
  • Centralize and harden validation so the public site can be regenerated only through the documented autonomous workflows.
  • Remove ambiguity about obsolete validation/workflow versions and enforce the AEP public-package allowlist.

Description

  • README refresh: replaced the top-level entry with an institutional README (README.md) that includes a truthful badge row, thesis lines, safe boundary, product ladder, shop routing, and validation/website guidance.
  • Single source of truth: added docs/data/goalos_catalog.yml containing project identity, product ladder, versions/prices, AEP list, validation & release status, approved/prohibited claims, and inventories.
  • Docs, figures, tables, badges: added/updated comprehensive docs under docs/ and docs/data/, created Mermaid sources and committed SVG exports for required figures in docs/figures/, added CSV tables in docs/tables/, and added static SVG badges under badges/.
  • Validation & paid-file guard: extended and added scripts scripts/validate_docs_tables_figures.py, scripts/validate_goalos_catalog.py, and kept scripts/check_no_paid_artifacts.py and scripts/validate_goalos_public_site.py; centralized public-site rules in scripts/goalos_public_site_rules.py.
  • CI/workflows: added/updated workflows to run docs/tables/figures validation, catalog validation, and paid-artifact checks (.github/workflows/validate-docs-tables-figures.yml, validate-goalos-catalog.yml, check-no-paid-artifacts.yml), and clearly marked obsolete validation workflows (v12/v13/old v8) so they are not presented as current.
  • Policies and governance: added targeted governance docs (CONTRIBUTING.md, SECURITY.md, QA_VERIFICATION.md, ROADMAP.md, docs/GOALOS_PAID_ARTIFACT_POLICY.md, docs/GOALOS_VALIDATION_HOTFIX_V14.md, etc.) and docs/GOALOS_REPO_AUDIT.md containing the audit results and commands run.
  • Non-destructive: preserved AEP standards, schemas, tests, proofs, proof_gradient package, QUEBEC.AI assets, and public-site release automation; did not add any paid buyer deliverables to public roots.

Testing

  • Validation scripts run locally and passed: python scripts/check_no_paid_artifacts.py, python scripts/validate_goalos_public_site.py, python scripts/validate_docs_tables_figures.py, and python scripts/validate_goalos_catalog.py all passed after minor link/compatibility fixes.
  • Unit/integration tests: pytest executed (installed missing httpx in the validation environment) and passed (85 passed, 3 warnings).
  • Unittest suite: make test passed (unittest discovery run; all tests passed).
  • Cloud MVP smoke test: node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs passed and reported expected proof metrics.

Commands used during verification: 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, pytest, make test, and node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs.


Codex Task

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0bfdaf322d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@@ -1,4 +1,4 @@
name: GoalOS Public Site Release (v8-intelligent-assets, obsolete compatibility validation)
name: GoalOS Public Site Release v8 Intelligent Assets

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep the release workflow from pretending to deploy

With this rename, the workflow is presented in Actions as the current v8 public-site release path, but inspected this same YAML: it has only contents: read, a validate-only job, and no Pages configure/upload/deploy step. When someone dispatches it expecting the documented v8 release, it will succeed after validation while leaving the public site unchanged.

Useful? React with 👍 / 👎.

Comment thread scripts/validate_goalos_catalog.py Outdated
Comment on lines +51 to +53
for label, body in (("README", readme), ("documentation", corpus)):
if price not in body or version not in body:
errors.append(f"{label} missing current price/version for {name}: {price} {version}")

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Require product names in README/catalog drift checks

In the README/documentation branch of this product check, the product name is never tested, so deleting or renaming GoalOS RSI Lite in the README still passes as long as $199 and v1.6 appear anywhere else in the file. That leaves the new catalog validation unable to catch the exact product-ladder drift it reports in the error message.

Useful? React with 👍 / 👎.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2359d5629d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- name: Check paid/private artifact boundary
run: python scripts/check_no_paid_artifacts.py
- name: Validate public site classification and shell rules
run: python scripts/validate_goalos_public_site.py

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Keep the Cloud MVP proof test in PR validation

When this PR workflow runs for changes under site/app/goalos-cloud-mvp/**, it now stops after the Python public-site validator. I checked scripts/validate_goalos_public_site.py, and app_page files are only checked for a <title>, while the remaining enterprise-core.test.mjs invocations are in workflow-dispatch/deploy-oriented workflows rather than this PR path; a change that breaks the Cloud MVP proof engine can therefore pass the current validation. Please keep the Node proof test, or an equivalent, in a PR-triggered workflow before accepting app changes.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant