Add production-level Table of Contents, npm, and Stripe sections to README#116
Add production-level Table of Contents, npm, and Stripe sections to README#116
Conversation
…EADME.md Co-authored-by: blackboxprogramming <118287761+blackboxprogramming@users.noreply.github.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
Adds navigation and “production-level” onboarding information to the root README to make the large document easier to traverse and to document npm/Stripe-related usage.
Changes:
- Added npm + license badges near the top of the README.
- Introduced a structured Table of Contents including links to subdirectory READMEs and major paper sections, plus a collapsible block for extended sections.
- Added new “Installation” (npm) and “Payments” (Stripe) sections.
Comments suppressed due to low confidence (4)
README.md:97
- The Installation block links to
https://github.com/blackboxprogramming/simulation-theory, but elsewhere in this README the repo is referenced asBlackRoad-OS-Inc/simulation-theory. Please align the GitHub link to the canonical repository to avoid sending users to the wrong place.
> **BlackRoad OS, Inc.** — [npm](https://www.npmjs.com/package/simulation-theory) · [GitHub](https://github.com/blackboxprogramming/simulation-theory)
README.md:114
- The payments tier table uses
||at the start of each row, which breaks GitHub-flavored Markdown table rendering. Use a single leading|per row so the table formats correctly.
| Tier | Description | Price |
|------|-------------|-------|
| Free | Public paper access, equations index | $0/mo |
| Pro | Full notebook, proofs, QWERTY constants API | $9/mo |
| Enterprise | BlackRoad OS SDK, 30,000 agent access, PS-SHA∞ | Contact us |
README.md:108
- This snippet says “Install the Stripe CLI” but
npm install --save stripeinstalls the Stripe Node SDK (a project dependency), not the Stripe CLI. Update the wording and/or the install command to match the intended tool (CLI vs Node library).
```bash
# Install the Stripe CLI
npm install --save stripe
**README.md:120**
* The text says “Configure your Stripe publishable key” but the code initializes Stripe with `process.env.STRIPE_SECRET_KEY`, which is the secret key. Please correct the wording and clarify that the secret key must only be used server-side (publishable key is a different value).
Configure your Stripe publishable key:
const stripe = require('stripe')(process.env.STRIPE_SECRET_KEY);</details>
---
💡 <a href="/blackboxprogramming/simulation-theory/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install simulation-theory | ||
| ``` | ||
|
|
||
| ```js | ||
| const { TrivialZero } = require('simulation-theory'); | ||
| ``` |
There was a problem hiding this comment.
The README now documents npm install simulation-theory and require('simulation-theory'), but this repo currently contains no package.json or JS/TS source files to build/publish an npm package. Either add the packaging artifacts (package.json + entrypoint) or clarify that the npm package lives elsewhere and link to its source.
README lacked any index, making the 17,900-line, 400+ section document nearly impossible to navigate. No npm or Stripe integration was documented.
Changes
README.md
equations/,proofs/,figures/,notebooks/,qwerty/) with one-line descriptions<details>block grouping all 400+ extended sectionsnpm install simulation-theorywith a usage snippetSTRIPE_SECRET_KEYenv setupOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.