Skip to content
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.

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

feat: Auto-Documentation Synchronization Bot #1224

Open
madjin opened this issue Dec 19, 2024 · 1 comment
Open

feat: Auto-Documentation Synchronization Bot #1224

madjin opened this issue Dec 19, 2024 · 1 comment
Labels
automation documentation Improvements or additions to documentation enhancement New feature or request

Comments

@madjin
Copy link
Collaborator

madjin commented Dec 19, 2024

Overview

Create an AI assistant to maintain documentation consistency and generate documentation from code.

Current Situation

Documentation gaps often go unnoticed, leading to challenges during onboarding, feature development, and integrations. Outdated information can result in inefficiencies, with developers spending unnecessary time answering questions that could otherwise be handled by AI if up-to-date documentation were available

Proposed Solution

First finish this issue: #1110
Next document plugins so that we have a quality reference: #1200

Then build a documentation bot that:

  1. Tracks and reports TODO comments in code (automate this flow chore: Review TODO notes #1223)
  2. Tracks and reports missing plugin docs: (automate this chore: Document Missing Plugin Documentation and Examples #1200)
  3. Tracks commits / issues / PRs and flags docs pages that might need updating
  4. Suggest documentation updates of those pages

Technical Details

@madjin madjin added documentation Improvements or additions to documentation enhancement New feature or request automation labels Dec 19, 2024
@madjin
Copy link
Collaborator Author

madjin commented Dec 26, 2024

Update

Next we can do better tracking of what files have changed that might affect which part of the docs. We can perhaps do this based on filepaths. The main Eliza docs all could use some updates. Will first update docusaurus config to show when doc pages were last edited.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant