Repository navigation
feat(update-project-settings): RM-18985 Add project settings skill for PATCH /v2/projects/me - #15
Conversation
|
This reverts commit f8926b4.
xavierandueza
left a comment
There was a problem hiding this comment.
self-reviewed, LGTM
runnabro
left a comment
There was a problem hiding this comment.
just blocking on the link, thx!
|
|
||
| ### Give the agent custom knowledge | ||
|
|
||
| Set `ai.chat.knowledge.custom_knowledge` to free text the agent should always know, such as a product terminology, target audience notes and more. It is sent in full with every agent request rather than searched, so keep it concise; writes over the length limit are rejected. Set it to `null` to clear it. Style guides exist under the "Docs Audit" feature and are better configured there. |
There was a problem hiding this comment.
| Set `ai.chat.knowledge.custom_knowledge` to free text the agent should always know, such as a product terminology, target audience notes and more. It is sent in full with every agent request rather than searched, so keep it concise; writes over the length limit are rejected. Set it to `null` to clear it. Style guides exist under the "Docs Audit" feature and are better configured there. | |
| Set `ai.chat.knowledge.custom_knowledge` to free text the agent should always know, such as product terminology, target audience notes, and more. It is sent in full with every agent request rather than searched, so keep it concise; writes over the length limit are rejected. Set it to `null` to clear it. Style guides exist under the "Docs Audit" feature and are better configured there. |
There was a problem hiding this comment.
confirmed fixed
|
|
||
| ## Slack AI Writer | ||
|
|
||
| The Slack AI Writer drafts documentation changes from Slack threads, opening a ReadMe branch per thread. See [AI Writer](https://docs.readme.com/main/docs/github-ai-writer). It is currently under closed beta, reach out to support@readme.io to request access. |
There was a problem hiding this comment.
(agent response)
Yes, it pointed to the GitHub AI Writer. The Slack AI Writer is in closed beta and has no public docs page, so I removed the link and kept the note about requesting access through support. 407290a
There was a problem hiding this comment.
Good callout.
We want this to point to:
https://docs.readme.com/main/docs/slack-ai-writer
Instead please - that's hidden for now but will be live by the time this merges in.
There was a problem hiding this comment.
(agent response)
Linked to the Slack AI Writer page instead. It is hidden for now and will be live before this merges. 011f3e7
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
minhthanhdang
left a comment
There was a problem hiding this comment.
I feel like lots of context about the endpoints should be in MCP tool/endpoint description rather than in skills here.
| ### Turn Ask AI on or off | ||
|
|
||
| Set `ai.owlbot.enabled`. | ||
|
|
||
| The `ai.owlbot.new_experience` is a legacy field - leave as `true` as the legacy experience is deprecated. | ||
|
|
||
| Without the AI Booster Pack, Ask AI offers limited customization. The Booster Pack is an add-on: `ai.owlbot.is_paying` reports whether the project has it. | ||
|
|
||
| ### Choose where Ask AI appears | ||
|
|
||
| Set `ai.owlbot.placements` (full array) to any of: | ||
|
|
||
| - `header`: a button in the page header | ||
| - `floating`: a floating button on every page, centered at the bottom | ||
| - `in_search`: inside the search modal - this appears as an 'Ask about "{query}"' and with the booster alternative questions will be generated that on selection will be sent to Ask AI. | ||
|
|
||
| The API stores placements in the order `header`, `floating`, `in_search`, whatever order you send. `in_search` only renders in the unified search modal (`appearance.navigation.search_modal: unified`). | ||
|
|
||
| The default is `header` and `in_search`. An empty array hides every surface while leaving Ask AI enabled. On an enterprise child, placements come from the parent until the child sets its own. | ||
|
|
||
| Related settings elsewhere: the Ask AI accent color (`appearance.brand.askai`) and the unified search modal that combines search with Ask AI (`appearance.navigation.search_modal`) are in [appearance](appearance.md). |
There was a problem hiding this comment.
For example, IMO these should be in endpoint description in MCP, it feels too low-level to be in a skill. Imagine we add a placement option in the future
There was a problem hiding this comment.
(agent response)
Agreed on the values. The skill already tells the agent to read the updateProject schema with get-endpoint, so the list of values and the default were duplicates that would drift. I removed them and now point to the schema. I kept only the behaviour the schema doesn't describe: in_search needs the unified search modal, the API stores placements in a fixed order, an empty array hides every surface, and how enterprise children inherit. cb824b7
|
(agent response) This skill is meant to hold what the schema can't say: which field matches a request, how fields affect each other (e.g. I fixed the placements example in cb824b7. Other places still repeat values from the schema, so we can trim those the same way. |
…oject-settings-skill
🧰 Changes
Reviewer Note - I wouldn't bother reading over the testing logic too much - its just to ensure that the endpoint and instructions here don't drift/when they do we catch it.
Creates the
update-project-stylingskill - covers everything inPATCH /v2/projects/meso largest one we have. I broke down the changes into different "categories" for each change that could be made.This one is MUCH more vibe-coded than the others due to the sheer number of things users can do here.
Note -> also made test cases because I want to make sure that long-term the things that we're saying can be done via this skill can continue to be done:
https://linear.app/readme-io/issue/RM-19065/setup-ci
🧬 QA & Testing