-
Notifications
You must be signed in to change notification settings - Fork 70
Let AI suggest long-term improvements for styleguide #1460
Copy link
Copy link
Open
Labels
scope: aiStandalone or auxiliary AI-related tasks and ideasStandalone or auxiliary AI-related tasks and ideasscope: ci/cdGitHub Actions (.github), related scripts, commit/push hooks (.husky)GitHub Actions (.github), related scripts, commit/push hooks (.husky)scope: contribute/contribute folder: style guides, custom additions to Mintlify/contribute folder: style guides, custom additions to Mintlify
Milestone
Metadata
Metadata
Assignees
Labels
scope: aiStandalone or auxiliary AI-related tasks and ideasStandalone or auxiliary AI-related tasks and ideasscope: ci/cdGitHub Actions (.github), related scripts, commit/push hooks (.husky)GitHub Actions (.github), related scripts, commit/push hooks (.husky)scope: contribute/contribute folder: style guides, custom additions to Mintlify/contribute folder: style guides, custom additions to Mintlify
Styleguide is a living document and it will never be "100% complete". Regular improvements are being made to it manually, but it requires a lot of effort from humans to manage. Creating well defined issues for every single minor thing that is currently "bad" is very boring, and even more than that - people cannot keep the whole styleguide in their head at all times when reviewing PRs, so in many cases they would simply miss potential things to improve in styleguide.
AI could help with this problem long-term. Suggested workflow:
The prompts for this thing should be strict enough to not let AI suggest dozens of improvements after every single PR.