Skip to content

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

Open
MontrealAI wants to merge 1 commit into
mainfrom
codex/refresh-documentation-and-readme
Open

Refresh GoalOS / Proof Gradient README, docs, figures, tables, badges, and validation#17
MontrealAI wants to merge 1 commit into
mainfrom
codex/refresh-documentation-and-readme

Conversation

@MontrealAI

Copy link
Copy Markdown
Owner

Motivation

  • Make the repository look and read like an official, institutional GoalOS platform with an authoritative README, clear product ladder, and bilingual-aware claims boundaries.
  • Create a single source of truth for offers, versions, prices, AEP standards and validation rules so documentation and site artifacts remain synchronized.
  • Harden public-site safety by enforcing a paid-file guard, documenting the v14 validation hotfix, and ensuring public AEP package allowlisting while avoiding publication of paid buyer files.

Description

  • Refresh README.md into an institutional front page with the identity line, core thesis, safe AI boundary, the core loop, a bilingual product ladder table, and a top-row of static SVG badges.
  • Add docs/data/goalos_catalog.yml as the canonical catalog plus a human docs/GOALOS_DOCUMENTATION_INDEX.md and operational GoalOS docs (Proof Card 001 plan, paid-artifact policy, validation hotfix v14, Cloud MVP 0.2, catalog audit, roadmap, Web3 architecture, professional-firm summaries, etc.).
  • Add required assets: docs/figures/*.mmd and committed SVG exports, docs/tables/*.csv CSV sources, static badge SVGs in badges/, and update REPO_FILE_TREE.txt and repository_manifest.json.
  • Add and update validation automation and CI: scripts/validate_docs_tables_figures.py, scripts/validate_goalos_catalog.py, small scripts/validate_goalos_public_site.py adjustments for v14 compatibility, extend tests/test_goalos_public_site_rules.py, and add/update GitHub Actions workflows (validate-docs-tables-figures.yml, check-no-paid-artifacts.yml, validate-goalos-catalog.yml).

Testing

  • Ran paid-artifact guard: python scripts/check_no_paid_artifacts.py — passed.
  • Ran public-site validator: python scripts/validate_goalos_public_site.py — passed (v14 compatibility logic active).
  • Ran docs/tables/figures and catalog validators: python scripts/validate_docs_tables_figures.py and python scripts/validate_goalos_catalog.py — both passed.
  • Ran unit/regression tests: pytest (after installing declared dev deps via python -m pip install -e '.[dev]') and make test, and the Cloud MVP Node test node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs — all passed.

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: d6122fdaa0

ℹ️ 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".

add_error(errors, rel, "is classified as standalone_proof_page but lacks a GoalOS / Proof Gradient link back", "add <a href=\"/proof-gradient/\">QUEBEC.AI ⚜️✨ · GoalOS · Proof Gradient</a>")
if not has_quebec_ai_visible_brand(text):
if explicit_standalone and not has_goalos_or_proof_gradient_escape(text):
add_error(errors, rel, "is classified as standalone_proof_page but lacks a GoalOS / Proof Gradient link back", "add <a href="/proof-gradient/">QUEBEC.AI ⚜️✨ · GoalOS · Proof Gradient</a>")

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 Escape the proof-gradient suggestion string

For explicit standalone proof pages that have GOALOS-STANDALONE-PROOF metadata but forget the GoalOS/Proof Gradient link-back, this line is evaluated while building the error message. Because the embedded href="/proof-gradient/" quotes are not escaped, Python parses it as string division using undefined names (proof, gradient), so the validator raises NameError instead of reporting the missing link and can make the public-site CI crash on the first such page.

Useful? React with 👍 / 👎.

Comment on lines +33 to +35
if importlib.util.find_spec('pytest') is None:
print('pytest unavailable; skipping optional paid-artifact regression tests')
sys.exit(0)

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 paid-artifact regression tests required

In this GitHub Actions job, no step installs the repo's dev dependencies before checking find_spec('pytest'), and pytest is only declared under optional dev dependencies in pyproject.toml. On a clean setup-python runner this branch exits 0, so the newly extended tests/test_goalos_public_site_rules.py regression coverage is silently skipped and future changes to the paid/private artifact classifier will not be caught by this workflow.

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