Repository navigation
Add Further reading for every company set - #96
Conversation
Company sets had no Further reading in Porridge because most had no teaching catalog, and principle pages only render blog from a teaching file. Require a catalog and a teaching file per principle. Reading-only files (id, slug, blog) are enough when full prose is not written. Official sources only. USMC now has doctrine, TBS, MCU, and the Commandant's reading list, plus a file per principle. Co-authored-by: Tig <tig@users.noreply.github.com>
|
@copilot review this pull request. Please review the validator change, the reading-only teaching shape, and the new official Further reading links. Flag any unofficial URL, a note that names a company where SCHEMA forbids it, or a missing live-corpus check. |
|
@codex review Please review the validator change, the reading-only teaching shape, and the new official Further reading links. Flag any unofficial URL, a note that names a company where SCHEMA forbids it, or a missing live-corpus check. |
xw-cto
left a comment
There was a problem hiding this comment.
no blocking findings on eb19323
I reviewed the final head as an independent check of the validator, the reading-only teaching shape, and the new Further reading links.
python3 scripts/validate.py passed: 10 companies, 111 principles. python3 -m unittest discover -s tests passed: 230 tests. GitHub CI on this head is green.
Every company has data/teaching/<company>/index.json and one teaching file per principle. Amazon and the universal set keep full teaching. Arm, Coupang, Delivery Hero, GitLab, Dawn, Toyota, Blue Origin, and USMC ship reading-only files (id, slug, blog). Catalog ids, slugs, and filenames match the records. require_teaching_coverage runs on the live tree, and the tests fail a missing catalog and a missing principle file.
I resolved every new URL. Each one is the company's own site, official doctrine, or the publisher page. I did not find an unofficial copy. GitLab CREDIT fragments match the handbook headings: #collaboration, #results, #efficiency, #diversity-inclusion, #iteration, #transparency. Notes do not name a source company where SCHEMA forbids it, and no reading-only note carries a {lp:} token.
USMC now has a solid official set on the catalog: the TBS Officership Foundations handout, MCWP 6-10, MCDP 6, the SMMC Leading Marines page, MCU LLI, Marine Leader Development, and both Commandant's Professional Reading List hosts. Every principle file has TBS plus MCWP 6-10. The extra official page sits on the principle it belongs to (traits on Know yourself, MCDP 6 on informed, understood, decisions, and employment, MLD on proficient, welfare, train as a team, and develop responsibility, SMMC on Set the example and Seek responsibility).
|
@codex review Independent review session started because Copilot request API returned 403 and no review landed on head eb19323 after ~2.5 hours. Please still review the validator change, the reading-only teaching shape, and the new official Further reading links. Flag any unofficial URL, a note that names a company where SCHEMA forbids it, or a missing live-corpus check. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: eb193238f9
ℹ️ 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".
The live validator now reports a missing teaching root and still runs coverage. Company-set cite tests reject any URL that is not on the official allowlist. The Commandant's list uses the current cmc-reading-list path. The Toyota philosophy note no longer names the company. Co-authored-by: Tig <tig@users.noreply.github.com>
|
@codex review Please review the latest head. I addressed the four findings on eb19323: live coverage now runs when the teaching root is absent, company-set cites reject URLs that are not on the official allowlist, the Commandant's list uses /cmc-reading-list, and the Toyota philosophy note no longer names the company. Flag any unofficial URL, a note that names a company where SCHEMA forbids it, or a missing live-corpus check. |
|
@copilot review this pull request. Please review the latest head (592aeda). Flag any unofficial URL, a note that names a company where SCHEMA forbids it, or a missing live-corpus check. |
xw-cto
left a comment
There was a problem hiding this comment.
no blocking findings on 592aeda
I re-reviewed the new head after the follow-up commit. python3 scripts/validate.py passed. python3 -m unittest discover -s tests passed: 231 tests.
The four follow-up edits hold. Live coverage now reports a missing data/teaching root and still lists the missing catalogs. Company-set cites reject a URL that is not on the official allowlist; the 28 live URLs match that list. The Commandant's list is https://grc-usmcu.libguides.com/cmc-reading-list, which resolves to the Library of the Marine Corps FY26 guide. The Toyota philosophy note no longer names the company.
I did not find an unofficial URL, a note that names a source company, or a missing live-corpus check on this head.
There was a problem hiding this comment.
🟢 Approval recommended
No blocking issues remain, and the reading-only records fit existing rendering with explicit coverage checks.
0 open findings
What changed in this PR
Completes Further reading data for every company in Porridge, including per-principle USMC reading beyond the catalog introduced in #94.
Changes:
- Adds official-source catalogs and reading-only principle files while preserving Amazon and universal teaching.
- Enforces complete teaching-file coverage and tests approved citations.
- Documents reading-only records and company onboarding requirements.
| File | Description |
|---|---|
| tests/test_validate.py | Tests reading-only records and missing-file checks. |
| tests/test_reading.py | Checks company coverage and approved citations. |
| scripts/validate.py | Supports reading-only records and requires coverage. |
| SCHEMA.md | Defines reading-only records and coverage requirements. |
| README.md | Updates teaching coverage and company list. |
| data/teaching/usmc/train-your-marines-as-a-team.json | Adds doctrine and team-development reading. |
| data/teaching/usmc/set-the-example.json | Adds doctrine and example-setting reading. |
| data/teaching/usmc/seek-responsibility-and-take-responsibility-for-your-actions.json | Adds responsibility reading. |
| data/teaching/usmc/make-sound-and-timely-decisions.json | Adds decision-making doctrine. |
| data/teaching/usmc/know-yourself-and-seek-self-improvement.json | Adds doctrine and leadership traits. |
| data/teaching/usmc/know-your-marines-and-look-out-for-their-welfare.json | Adds welfare and development reading. |
| data/teaching/usmc/keep-your-marines-informed.json | Adds communication doctrine. |
| data/teaching/usmc/index.json | Lists all principles and expands official reading. |
| data/teaching/usmc/ensure-the-task-is-understood-supervised-and-accomplished.json | Adds task execution doctrine. |
| data/teaching/usmc/employ-your-unit-in-accordance-with-its-capabilities.json | Adds unit employment doctrine. |
| data/teaching/usmc/develop-a-sense-of-responsibility-in-your-subordinates.json | Adds subordinate-development reading. |
| data/teaching/usmc/be-technically-and-tactically-proficient.json | Adds proficiency and development reading. |
| data/teaching/toyota/teamwork.json | Adds Toyota Way teamwork sources. |
| data/teaching/toyota/respect.json | Adds Toyota Way respect sources. |
| data/teaching/toyota/kaizen.json | Adds Toyota Way improvement sources. |
| data/teaching/toyota/index.json | Adds catalog and corporate philosophy reading. |
| data/teaching/toyota/genchi-genbutsu.json | Adds Toyota Way observation sources. |
| data/teaching/toyota/challenge.json | Adds Toyota Way challenge sources. |
| data/teaching/gitlab/transparency.json | Links the Transparency value. |
| data/teaching/gitlab/results-for-customers.json | Links the Results value. |
| data/teaching/gitlab/iteration.json | Links the Iteration value. |
| data/teaching/gitlab/index.json | Adds CREDIT catalog and handbook reading. |
| data/teaching/gitlab/efficiency.json | Links the Efficiency value. |
| data/teaching/gitlab/diversity-inclusion-and-belonging.json | Links the inclusion value. |
| data/teaching/gitlab/collaboration.json | Links the Collaboration value. |
| data/teaching/delivery-hero/stay-humble.json | Adds principle and culture sources. |
| data/teaching/delivery-hero/raise-the-bar.json | Adds principle and culture sources. |
| data/teaching/delivery-hero/own-it.json | Adds principle and culture sources. |
| data/teaching/delivery-hero/index.json | Adds catalog and official set reading. |
| data/teaching/delivery-hero/dive-deep.json | Adds principle and culture sources. |
| data/teaching/delivery-hero/deliver-value-fast.json | Adds principle and culture sources. |
| data/teaching/delivery-hero/bring-good-vibes.json | Adds principle and culture sources. |
| data/teaching/dawn/think-big-start-small.json | Adds mission and careers reading. |
| data/teaching/dawn/scrappy-not-crappy.json | Adds mission and careers reading. |
| data/teaching/dawn/rocket-engineering-not-rocket-science.json | Adds mission and careers reading. |
| data/teaching/dawn/respect-time.json | Adds mission and careers reading. |
| data/teaching/dawn/race-on-the-racetrack-walk-on-ice.json | Adds mission and careers reading. |
| data/teaching/dawn/ownership.json | Adds mission and careers reading. |
| data/teaching/dawn/no-surprises.json | Adds mission and careers reading. |
| data/teaching/dawn/invent-and-simplify.json | Adds mission and careers reading. |
| data/teaching/dawn/index.json | Adds tenet catalog and public context sources. |
| data/teaching/dawn/hire-and-develop-the-best.json | Adds mission and careers reading. |
| data/teaching/dawn/have-backbone-disagree-and-commit.json | Adds mission and careers reading. |
| data/teaching/dawn/earn-trust.json | Adds mission and careers reading. |
| data/teaching/dawn/customer-success-is-our-success.json | Adds mission and careers reading. |
| data/teaching/dawn/break-down-silos.json | Adds mission and careers reading. |
| data/teaching/dawn/bias-for-action.json | Adds mission and careers reading. |
| data/teaching/dawn/better-than-yesterday.json | Adds mission and careers reading. |
| data/teaching/coupang/wow-the-customer.json | Links official principle wording. |
| data/teaching/coupang/think-systematically.json | Links official principle wording. |
| data/teaching/coupang/simplify.json | Links official principle wording. |
| data/teaching/coupang/ruthless-prioritization.json | Links official principle wording. |
| data/teaching/coupang/move-with-urgency.json | Links official principle wording. |
| data/teaching/coupang/learn-voraciously.json | Links official principle wording. |
| data/teaching/coupang/influence-without-authority.json | Links official principle wording. |
| data/teaching/coupang/index.json | Adds catalog and official set reading. |
| data/teaching/coupang/hire-and-develop-the-best.json | Links official principle wording. |
| data/teaching/coupang/hate-waste.json | Links official principle wording. |
| data/teaching/coupang/dive-deep.json | Links official principle wording. |
| data/teaching/coupang/disagree-and-commit.json | Links official principle wording. |
| data/teaching/coupang/demand-excellence.json | Links official principle wording. |
| data/teaching/coupang/deliver-results-with-grit.json | Links official principle wording. |
| data/teaching/coupang/company-wide-perspective.json | Links official principle wording. |
| data/teaching/coupang/aim-high-and-find-a-way.json | Links official principle wording. |
| data/teaching/blue-origin/technical-ambition-and-simplicity.json | Adds culture and mission sources. |
| data/teaching/blue-origin/resourceful.json | Adds culture and mission sources. |
| data/teaching/blue-origin/practice-humility.json | Adds culture and mission sources. |
| data/teaching/blue-origin/passion-for-our-mission.json | Adds culture and mission sources. |
| data/teaching/blue-origin/ownership.json | Adds culture and mission sources. |
| data/teaching/blue-origin/operational-excellence.json | Adds culture and mission sources. |
| data/teaching/blue-origin/insist-on-the-highest-standards.json | Adds culture and mission sources. |
| data/teaching/blue-origin/index.json | Adds catalog and official set reading. |
| data/teaching/blue-origin/hire-and-develop-the-best.json | Adds culture and mission sources. |
| data/teaching/blue-origin/have-backbone-disagree-and-commit.json | Adds culture and mission sources. |
| data/teaching/blue-origin/embrace-team-blue.json | Adds culture and mission sources. |
| data/teaching/blue-origin/earn-the-trust-of-others.json | Adds culture and mission sources. |
| data/teaching/blue-origin/deliver-results.json | Adds culture and mission sources. |
| data/teaching/blue-origin/customer-focus.json | Adds culture and mission sources. |
| data/teaching/blue-origin/bias-for-action.json | Adds culture and mission sources. |
| data/teaching/arm/root-out-inefficiencies.json | Adds mindset and company sources. |
| data/teaching/arm/relentlessly-push-boundaries.json | Adds mindset and company sources. |
| data/teaching/arm/passion-for-the-mission.json | Adds mindset and company sources. |
| data/teaching/arm/own-it.json | Adds mindset and company sources. |
| data/teaching/arm/optimize-for-endurance-and-resilience.json | Adds mindset and company sources. |
| data/teaching/arm/move-with-urgency-and-find-a-way.json | Adds mindset and company sources. |
| data/teaching/arm/index.json | Adds 10x Mindset catalog and reading. |
| data/teaching/arm/deliver-as-one-arm.json | Adds mindset and company sources. |
| data/teaching/arm/challenge-skillfully.json | Adds mindset and company sources. |
| data/teaching/arm/build-extraordinary-teams.json | Adds mindset and company sources. |
| data/teaching/arm/be-decisive-in-ambiguity-and-change.json | Adds mindset and company sources. |
| AGENTS.md | Requires official reading during company onboarding. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Porridge only renders Further reading from
data/teaching/<company>/. The live list page already switches that block with the company tile. The gap was the data.I checked kindel.com/kld/apps/porridge/. The universal set and Amazon already have catalogs. USMC has the two-link catalog from #94, hidden until you pick that tile. Arm, Coupang, Delivery Hero, GitLab, Dawn, Toyota, and Blue Origin have no teaching directory, so those tiles show none. Principle pages only load
teaching/<company>/<slug>.json. Only Amazon and the universal set had those files, so a USMC principle page had no Further reading at all.kindelwww#295's Azure stage 404s at both
/kld/apps/porridge/and/apps/porridge/. Live already has the USMC records and the thin USMC catalog, so the missing links are not a pin bug. I am not opening a kindelwww PR. The pin comes after this merges.Porridge and BIQ need no code change. Porridge already loads every company's teaching index and principle file when they exist. BIQ does not render
blog.What I changed
Every company now has a catalog and a teaching file per principle. Amazon and the universal set keep their full teaching. The others ship reading-only files (
id,slug,blog) from official sources.validate.pyfails the live tree when a company is missing a catalog or a principle file. A missing file is a silent empty section in the apps, so that check is the contract. If the teaching directory itself is gone, the live validator now reports that and still runs the per-company coverage check.Company-set cite tests now reject any URL that is not on the official allowlist.
New links
Arm
Set and every principle:
Coupang
Set and every principle:
Delivery Hero
Set and every principle:
GitLab
Set:
Each principle adds the CREDIT heading on that page:
Dawn Aerospace
The tenets are first-party text published with permission, not a public tenets page. Set and every principle:
Toyota
Set:
Each principle uses the Toyota Way 2001 page and the 2018 annual report.
Blue Origin
Set and every principle:
U.S. Marine Corps
Already on the catalog: the 14 traits page and the TBS Officership Foundations PDF.
New on the catalog:
Every principle file has the TBS handout and MCWP 6-10. Extra official pages sit on the principle they belong to: the 14 traits page on Know yourself; MCDP 6 on informed, understood, decisions, and employment; MCU Marine Leader Development on proficient, welfare, train as a team, and develop responsibility; the SMMC Leading Marines page on Set the example and Seek responsibility.
Amazon and the universal set
No new links. Those catalogs and principle files already had Further reading.
I did not use unofficial copies. I checked each new URL against the company's own page, official doctrine, or the publisher's page.