Conversation
There was a problem hiding this comment.
Pull request overview
This PR restores npm-first quickstart examples in the documentation after publishing version 0.1.1 of @venikman/fpf to npm. The changes update documentation to show the npm-based installation method as the primary approach while maintaining local fallback instructions for users who prefer to run from the repository.
Changes:
- Bumped package version from 0.1.0 to 0.1.1
- Updated README files to show npm-based
bunx --bun @venikman/fpfcommands as the primary usage method - Added "Local fallback" sections with instructions for running from the repository
- Updated CHANGELOG to document the 0.1.1 release
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/fpf/package.json | Version bump to 0.1.1 |
| packages/fpf/README.md | Restructured to show npm commands first with local fallback alternatives |
| README.md | Added local fallback examples for quickstart and machine mode |
| CHANGELOG.md | Added 0.1.1 release notes and cleaned up 0.1.0 entry |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📝 WalkthroughWalkthroughThis release updates the package version to 0.1.1 and adds documentation examples demonstrating local fallback methods for running fpf commands without npm, using repository path-based invocation alongside existing npm-based usage. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
Summary of ChangesHello @venikman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request primarily focuses on improving the user documentation for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to restore npm-first quickstart examples and adds local fallback instructions, along with bumping the package version. The changes are a good improvement. My review focuses on enhancing the clarity and consistency of the documentation examples. I've provided suggestions to make the code snippets in the README files more robust and self-contained, ensuring a smoother experience for users following the quickstart guides.
| FPF_REPO=/path/to/fpf-foundry | ||
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | cat | ||
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json | cat |
There was a problem hiding this comment.
To make this example self-contained and clearer for users, I suggest including the directory creation and git initialization steps, similar to the main quickstart example. This ensures the commands run in the correct context without relying on previous steps.
The preceding npm example for machine mode should also be updated for consistency.
| FPF_REPO=/path/to/fpf-foundry | |
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | cat | |
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json | cat | |
| FPF_REPO=/path/to/fpf-foundry | |
| mkdir fpf-demo-json && cd fpf-demo-json | |
| git init -q | |
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | cat | |
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json | cat |
|
|
||
| ```bash | ||
| FPF_REPO=/path/to/fpf-foundry | ||
| mkdir my-fpf && cd my-fpf |
There was a problem hiding this comment.
For consistency with the root README.md and to ensure the example is complete, I suggest two changes:
- Use
fpf-demoas the directory name instead ofmy-fpf. - Add
git init -qafter creating the directory. Thefpfcommands seem to operate within a git repository context, and this step is present in the rootREADME.md's quickstart.
This will make the example more robust. The preceding npm example should also be updated similarly for consistency.
| mkdir my-fpf && cd my-fpf | |
| mkdir fpf-demo && cd fpf-demo | |
| git init -q |
| FPF_REPO=/path/to/fpf-foundry | ||
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | ||
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json |
There was a problem hiding this comment.
To make this example self-contained and clearer for users, I suggest including the directory creation and git initialization steps. This ensures the commands run in the correct context without relying on previous steps being completed.
Using a different directory name like fpf-demo-json avoids conflicts with the previous example. The preceding npm example for machine output should also be updated for consistency.
| FPF_REPO=/path/to/fpf-foundry | |
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | |
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json | |
| FPF_REPO=/path/to/fpf-foundry | |
| mkdir fpf-demo-json && cd fpf-demo-json | |
| git init -q | |
| "$FPF_REPO"/packages/fpf/bin/fpf init --root . --json | |
| "$FPF_REPO"/packages/fpf/bin/fpf check --root . --json |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 3-6: Update the "## 0.1.1" changelog section to include a bullet
noting the documentation updates: add a line such as "Add local fallback usage
examples to both READMEs" (or similar) alongside the existing "Publish 0.1.1 to
npm." so the release notes reflect the README changes.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CHANGELOG.mdREADME.mdpackages/fpf/README.mdpackages/fpf/package.json
🧰 Additional context used
🧠 Learnings (18)
📓 Common learnings
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Local CLI must be invoked via `bun packages/fpf/bin/fpf` for development testing
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/bin/fpf : CLI bin file must have shebang at `packages/fpf/bin/fpf`
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf init` command must create a minimal FPF workspace under `--root` directory with optional `--template minimal` and `--force` flags
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `1` indicates usage, input, or IO error
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : Domain commands (`fpf mint-name`, `fpf record-drr`, `fpf log-work`) must accept `--root` flag and support `--json` mode
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `0` indicates success
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf doctor` command must report environment and root status
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `0` indicates success
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf init` JSON output must include `created`, `updated`, and `skipped` fields
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf check` JSON output must include `issues[]` array field (empty on success)
Applied to files:
packages/fpf/package.jsonpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `1` indicates usage, input, or IO error
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `2` indicates invariant check failed (from `fpf check` command)
Applied to files:
packages/fpf/package.jsonREADME.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : In JSON mode (`--json` flag), every command must print exactly one JSON object to stdout, terminated by newline
Applied to files:
packages/fpf/package.json
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : CLI exit code `3` indicates unhandled or internal error
Applied to files:
packages/fpf/package.jsonpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Local CLI must be invoked via `bun packages/fpf/bin/fpf` for development testing
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/entry.ts : CLI entrypoint must be compiled to `packages/fpf/src/entry.ts`
Applied to files:
packages/fpf/package.jsonCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf init` command must create a minimal FPF workspace under `--root` directory with optional `--template minimal` and `--force` flags
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/bin/fpf : CLI bin file must have shebang at `packages/fpf/bin/fpf`
Applied to files:
packages/fpf/package.jsonREADME.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : Domain commands (`fpf mint-name`, `fpf record-drr`, `fpf log-work`) must accept `--root` flag and support `--json` mode
Applied to files:
README.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf check` command must validate SkillSpec files at `design/skills/**/skill.json`, verify `design/skills/SKILL_INVENTORY.md`, and run inventory and unicode safety checks
Applied to files:
README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf doctor` command must report environment and root status
Applied to files:
README.mdCHANGELOG.mdpackages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : Global `--root <dir>` flag must default to `process.cwd()` and be available on all commands
Applied to files:
packages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : `fpf doctor` command must support optional `--check` flag that embeds `fpf check` output under `check` field
Applied to files:
packages/fpf/README.md
📚 Learning: 2026-01-14T09:45:01.365Z
Learnt from: CR
Repo: venikman/fpf-foundry PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-01-14T09:45:01.365Z
Learning: Applies to packages/fpf/src/**/*.ts : Global `--json` flag must be available on all commands to enable machine-readable output mode
Applied to files:
packages/fpf/README.md
🔇 Additional comments (5)
packages/fpf/package.json (1)
3-3: LGTM!Version bump to 0.1.1 is appropriate for this release.
CHANGELOG.md (1)
9-9: LGTM!The updated 0.1.0 entry clearly describes the initial release.
packages/fpf/README.md (2)
28-35: LGTM!The local fallback examples are consistent and provide clear alternatives to npm-based usage. The explicit
--root .flag improves clarity even though it defaults to the current directory.Also applies to: 44-50
13-18: No changes needed. The documented local invocation method using direct execution ("$FPF_REPO"/packages/fpf/bin/fpf) is correct and appropriate. With the shebang#!/usr/bin/env bunand executable permissions (100755) in place, direct execution is functionally equivalent to explicitbuninvocation and is the proper approach for end-user documentation.Likely an incorrect or invalid review comment.
README.md (1)
31-43: LGTM!Local fallback sections are consistent with the package README and provide clear npm-free workflow options. The examples correctly demonstrate the same functionality via repository-path invocation.
Also applies to: 52-58
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| ## 0.1.1 | ||
|
|
||
| - Publish 0.1.1 to npm. | ||
|
|
There was a problem hiding this comment.
Consider documenting the documentation updates.
The changelog entry "Publish 0.1.1 to npm." is accurate but doesn't mention the documentation changes (local fallback usage examples added to both READMEs). Consider adding a bullet point describing these updates for better release transparency.
📝 Suggested enhancement
## 0.1.1
- Publish 0.1.1 to npm.
+- Add local fallback usage examples to documentation (npm-free workflow).🤖 Prompt for AI Agents
In `@CHANGELOG.md` around lines 3 - 6, Update the "## 0.1.1" changelog section to
include a bullet noting the documentation updates: add a line such as "Add local
fallback usage examples to both READMEs" (or similar) alongside the existing
"Publish 0.1.1 to npm." so the release notes reflect the README changes.
|
Codex Review: Didn't find any major issues. 🎉 ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
Summary
Testing
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.