Skip to content

Document default data locations in Getting Started #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
doronpers merged 1 commit into from
Jan 16, 2026
+10 −0
Merged

Document default data locations in Getting Started #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions documentation/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,16 @@ This interactive demo shows:

**Try this:** When prompted, ask it to generate code for "process NumPy array to JSON" - it will automatically apply the right patterns.

## Data Locations

By default, feedback-loop stores learning artifacts in these locations:

- **Metrics** (test runs): `data/metrics_data.json`
- **Patterns** (learned library): `data/patterns.json`
Comment on lines +82 to +83
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The default paths data/metrics_data.json and data/patterns.json appear to be inconsistent with the defaults defined in some core components. For instance, metrics.pattern_manager.PatternManager defaults to patterns.json and metrics.sync_client.LocalSyncClient defaults to metrics_data.json, both without the data/ prefix. This discrepancy could cause files to be created in the project root instead of the data/ directory, leading to user confusion. To ensure consistency, it would be best to either align the documentation with the actual behavior or update the code to match these documented paths.

- **Optional markdown sync** (pattern guide): `docs/AI_PATTERNS_GUIDE.md`
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point readers at the real AI patterns guide path

This line says the default markdown sync target is docs/AI_PATTERNS_GUIDE.md, but the repo’s canonical guide lives under documentation/AI_PATTERNS_GUIDE.md (README.md 94-99). A new user following Getting Started will look for or sync to a different path than the rest of the documentation uses, which risks creating a separate, out‑of‑sync guide. Consider aligning this path with the documented guide location or clarifying that it’s a separate sync output.

Useful? React with 👍 / 👎.

Copy link

Copilot AI Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documented path for the optional markdown sync is docs/AI_PATTERNS_GUIDE.md, which matches the default path used in the code (e.g., in metrics/integrate.py line 69). However, the actual file currently exists at documentation/AI_PATTERNS_GUIDE.md. This creates a discrepancy where the code's default path points to a location where the file doesn't exist. Consider either updating the code's default path to match the actual file location, or clarifying in the documentation that users may need to adjust this path or create a symlink.

Suggested change
- **Optional markdown sync** (pattern guide): `docs/AI_PATTERNS_GUIDE.md`
- **Optional markdown sync** (pattern guide): `docs/AI_PATTERNS_GUIDE.md` (default code path; the file currently lives at `documentation/AI_PATTERNS_GUIDE.md`, so either adjust the path via CLI flags or create a symlink)

Copilot uses AI. Check for mistakes.

If you change paths via CLI flags, keep these files together so the metrics and pattern sync stay aligned.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase 'keep these files together' is a bit ambiguous. To improve clarity for the user, I suggest rephrasing it to be more specific about the location.

Suggested change
If you change paths via CLI flags, keep these files together so the metrics and pattern sync stay aligned.
If you change paths via CLI flags, it is recommended to keep these files in the same directory so the metrics and pattern sync stay aligned.


## What's Next?

### Use in Your Project
Expand Down