docs: Add Phase 1 CLI and Phase 2 API usage examples to README#36
Draft
ShockaHolmes with Copilot wants to merge 2 commits into
Draft
docs: Add Phase 1 CLI and Phase 2 API usage examples to README#36ShockaHolmes with Copilot wants to merge 2 commits into
ShockaHolmes with Copilot wants to merge 2 commits into
Conversation
Agent-Logs-Url: https://github.com/ShockaHolmes/NoteForge/sessions/2bf0a9a5-6952-4a25-b670-331e4244f788 Co-authored-by: ShockaHolmes <78627489+ShockaHolmes@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README with CLI and API usage labels
docs: Add Phase 1 CLI and Phase 2 API usage examples to README
Apr 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README lacked concrete runnable examples for the CLI and REST API, leaving readers to infer invocation syntax from code and the API endpoint table alone.
Changes
Getting Started
pip install fastapi uvicorn pyyaml, and seeding~/.notes/notes/fromtest-notes/Phase 1 — Running the CLI
New sub-section with labeled
bashexamples using the real entry point for every implemented command:Phase 2 — Starting the API Server
New sub-section with
uvicornstartup command and links to/docs,/redoc, and/health.Phase 2 — Notes API usage
Labeled
curlexamples coveringGET,POST,PATCH,PUT,DELETE, and/api/search?q=.Phase 2 — Datasets API usage
Labeled
curlexamples for multipart CSV/JSON upload, list, metadata get/patch/delete,/preview, and/profile. Explicitly calls out the sidecar YAML creation and~/.notes/datasets/storage location.API Endpoints table
Updated to reflect the actual implemented routes —
PATCHadded for both notes and datasets (previously only listedPUT).