Skip to content

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

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

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

Conversation

@MontrealAI

Copy link
Copy Markdown
Owner

Motivation

  • Make the repository look official, institutional, and release-safe by refreshing the public README, documentation map, diagrams, and product ladder.
  • Centralize public facts and product metadata in a single source of truth so docs, tables, and site copy cannot drift.
  • Harden the public-site validation and paid-file guard (AEP allowlist preserved) to prevent accidental publication of paid buyer artifacts and to declare v14 validation as current.

Description

  • Refreshed README.md into an official Proof Gradient · GoalOS landing page with badge row, identity line, safe-AI boundary, core loop, bilingual product ladder, AEP standards, Cloud MVP status, validation notes (v14), and run/test instructions.
  • Added a catalog source of truth at docs/data/goalos_catalog.yml and synchronized CSV tables under docs/tables/ for product ladder, offers, claim boundaries, validation rules, assets, and more.
  • Added/updated operational docs under docs/ (documentation index, commercialization, product ladder, Proof Card 001 plan, Cloud MVP, validation hotfix v14, paid-artifact policy, claims boundary, Web3 position, professional-pack summaries, engineering roadmap, repo audit, etc.).
  • Added figures (docs/figures/*.mmd) and lightweight SVG exports, static badge SVGs under badges/, and several validation/consistency scripts (scripts/validate_docs_tables_figures.py, scripts/validate_goalos_catalog.py, scripts/check_no_paid_artifacts.py), plus tightened scripts/goalos_public_site_rules.py and scripts/validate_goalos_public_site.py; created/updated GitHub Actions to run these checks and marked obsolete v12/v13 validation workflows as such.

Testing

  • python scripts/check_no_paid_artifacts.py — passed.
  • python scripts/validate_goalos_public_site.py — passed (v14 microsite compatibility logic applied).
  • python scripts/validate_docs_tables_figures.py — passed.
  • python scripts/validate_goalos_catalog.py — passed.
  • node site/app/goalos-cloud-mvp/tests/enterprise-core.test.mjs — passed.
  • pytest -q and make test — initially one test collection error occurred due to a missing local test dependency (httpx2), the dependency was installed in the validation environment and the full test suite subsequently 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: ad615eb5ad

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

Comment on lines +97 to +104
for link in MD_LINK_RE.findall(text):
if link.startswith(("http://", "https://", "mailto:", "#")):
continue
target = link.split("#", 1)[0].split("?", 1)[0]
if not target:
continue
if not (path.parent / target).resolve().exists():
fail(errors, f"Broken internal link in {path.relative_to(ROOT)}: {link}")

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 Restore blocked-artifact checks for local doc links

When README or a required doc links to a local paid/private artifact, this now only checks whether the target exists. The previous validator rejected markdown links via is_blocked_paid_or_private_artifact(clean), but the new RAW_BLOCKED_LINK_RE only covers HTTP URLs, so a link such as [buyer kit](GoalOS_...BUYER.zip) or a relative complete_bundle.zip can pass CI as long as the file exists, weakening the paid-file boundary this validator is meant to enforce.

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