Skip to content

chore: updating ai documentation for constraints#450

Merged
jaredwray merged 3 commits intomainfrom
chore-updating-ai-documentation-for-constraints
Apr 26, 2026
Merged

chore: updating ai documentation for constraints#450
jaredwray merged 3 commits intomainfrom
chore-updating-ai-documentation-for-constraints

Conversation

@jaredwray
Copy link
Copy Markdown
Owner

@jaredwray jaredwray commented Apr 26, 2026

Please check if the PR fulfills these requirements

  • Followed the Contributing and Code of Conduct guidelines.
  • Tests for the changes have been added (for bug fixes/features) with 100% code coverage.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
chore: updating ai documentation for constraints

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c2cb503) to head (846f5a4).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #450   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          518       518           
  Branches       144       144           
=========================================
  Hits           518       518           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 381535e7f7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

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".

Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces the ability to constrain AI-generated metadata fields—specifically tags, keywords, and categories—to a controlled vocabulary using the allowedTags, allowedKeywords, and allowedCategories options. The review feedback identifies several technical inaccuracies in the newly added documentation and JSDoc. Specifically, the feedback notes that the documentation should clarify that tags and keywords use an array of enums rather than a single enum, and that implicit enablement of these fields only occurs when the provided constraint arrays are non-empty.

Comment thread src/writr-ai.ts Outdated
Comment thread src/writr-ai.ts Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@jaredwray jaredwray merged commit 16787f1 into main Apr 26, 2026
11 checks passed
@jaredwray jaredwray deleted the chore-updating-ai-documentation-for-constraints branch April 26, 2026 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant