docs: add logs, docs, functions delete, and schedules commands #16#22
docs: add logs, docs, functions delete, and schedules commands #16#22jwfing merged 4 commits intoInsForge:mainfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughAdds four README CLI command sections— Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Closes #16 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 148-154: Update the README section for the insforge docs command
to document its optional positional arguments and examples: state that the
command accepts optional [feature] and [language] arguments, list supported
features (db, storage, functions, auth, ai, realtime) and supported languages
(typescript, swift, kotlin, rest-api), and add several usage examples
demonstrating both listing all docs (insforge docs) and filtered invocations
(e.g., insforge docs db typescript, insforge docs auth swift, insforge docs
storage rest-api) so users understand the command's flexibility.
- Around line 140-146: Update the README entry for the insforge logs command to
document the allowed <source> values and the --limit option and add usage
examples: state that <source> must be one of insforge.logs, postgREST.logs,
postgres.logs, or function.logs, document that --limit controls how many entries
are returned (default 20), and include at least two concrete examples such as
"insforge logs insforge.logs" and "insforge logs postgres.logs --limit 50" so
users can run the command without invoking --help.
- Around line 436-442: The README's schedules section only documents `insforge
schedules list`; add full documentation entries for the remaining subcommands:
`insforge schedules get`, `insforge schedules create`, `insforge schedules
update`, `insforge schedules delete`, and `insforge schedules logs`. For each
subcommand follow the same format as other command groups: a short description,
required flags/arguments (e.g., schedule ID or name), and a usage example (bash
block) showing typical options (for create/update include spec/cron/target
flags, for logs include --follow/--tail or --since as applicable). Ensure the
headings match the existing style (e.g., "Schedules — `insforge schedules`"
subsections) and mirror phrasing and examples used in `db`, `functions`,
`storage` sections for consistency.
jwfing
left a comment
jwfing
left a comment
There was a problem hiding this comment.
I think the comments of coderabbit are reasonable.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 303-309: Replace the placeholder usage for the insforge functions
delete command with concrete examples: show "insforge functions delete
my-function" and include the non-interactive variant "insforge functions delete
my-function -y # skip confirmation" so the README's style matches other
commands; update the section containing the "insforge functions delete" heading
and usage block accordingly.
README.md
Outdated
| insforge docs | ||
|
|
||
| # Specific feature/language docs | ||
| insforge docs db typescript |
There was a problem hiding this comment.
insforge docs instructions Show setup instructions
please add it into README, setup instructions is very important for being aware the entire backend.
jwfing
left a comment
jwfing
left a comment
There was a problem hiding this comment.
The PR has been significantly updated since my last review, thanks for your effort.
I think I can merge it If you add insforge docs instructions.
2 participants
Summary by CodeRabbit