Skip to content

Sharpen Tiny Stories project profile for technical review - #22

Open
lishehao wants to merge 1 commit into
mainfrom
codex/readme-grad-profile
Open

Sharpen Tiny Stories project profile for technical review#22
lishehao wants to merge 1 commit into
mainfrom
codex/readme-grad-profile

Conversation

@lishehao

Copy link
Copy Markdown
Owner

What changed

  • Rebuilt the root README around an admissions/recruiting review path instead of repeated feature copy.
  • Added a dynamic CI badge, clearer product thesis, verified 12-turn Live API evidence, updated hybrid-runtime architecture, and a focused source map.
  • Made the boundary explicit: this is validated AI product-systems evidence, not consumer traction or a research-contribution claim.
  • Updated README contract tests so they protect durable evidence, public/local visibility boundaries, and player/reviewer separation rather than exact legacy prose.

Why

The previous README repeated the demo and reviewer instructions while burying the strongest R&D evidence. The new structure makes the product question, engineering contribution, evaluation protocol, known latency risk, and reviewer path legible in the first few minutes.

Validation

  • Full backend pytest suite
  • Frontend TypeScript check and production build
  • GitHub GFM render through the Markdown API
  • All local README links/assets present
  • Public demo, YouTube demo, CI badge return HTTP 200
  • Public evidence preflight passes on the base commit
  • Production dependency audit reports 0 vulnerabilities

The existing Vite large-chunk warning remains unchanged.

@lishehao
lishehao marked this pull request as ready for review July 16, 2026 02:50

@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: 1dc1378b3c

ℹ️ 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 thread README.md
consequences, and people. Reviewer mode owns judge rows and sanitized
telemetry; raw prompts, provider payloads, and private reasoning stay out.

## Reviewer Path

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 README anchor compatible with public links

Renaming this heading changes GitHub's generated anchor from #reviewer-run to #reviewer-path, but the deployed landing page still links to https://github.com/lishehao/RPG_Demo#reviewer-run in docs/index.html (I found three occurrences with repo-wide search). In the public reviewer flow, those “Reviewer run guide” links will now land at the top of the repository instead of the reviewer instructions, so either keep a compatible Reviewer Run anchor or update the landing-page links/tests together.

Useful? React with 👍 / 👎.

Comment thread README.md
Comment on lines +271 to 274
For a configured live backend:

```bash
python3 tools/http_product_smoke.py --base-url http://127.0.0.1:8000

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 Document the authoring-disabled smoke path

For production-like backends with APP_PUBLIC_DEMO_AUTHORING_ENABLED=false, the default smoke command below still tries to create a template via POST /narrative/templates, which rpg_backend/main.py blocks when authoring is disabled. I checked python3 tools/http_product_smoke.py --help, and --use-first-public-template is the supported mode to “skip template creation” when authoring is disabled; removing that documented command makes the live-backend verification path fail before it reaches Play in that context.

Useful? React with 👍 / 👎.

Comment thread README.md
Comment on lines +175 to +182
Before citing a deployed route as application evidence, run:

```bash
python3 tools/portfolio_public_evidence_preflight.py
```

Each turn follows the same control pattern:
This checks whether the public branch and GitHub Pages deployment actually
contain the evidence being referenced.

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 public check scoped to repo evidence too

Narrowing the gate to “a deployed route” drops the repository/docs case even though the same preflight is meant to protect README.md, docs/, and other evidence-sensitive paths from being cited before they are pushed. In the scenario where a reviewer is sent the GitHub repo or evidence packet rather than a Pages route while local HEAD is ahead of origin/main, this wording no longer tells the sender to run the check, so reviewers can be pointed at evidence they cannot see publicly.

Useful? React with 👍 / 👎.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant