Merge pull request elizaOS#3906 from elizaOS/jin-docs-march

chore: major docs cleanup

Author: lalalune

.github/workflows/fetch-news.yml

@@ -0,0 +1,27 @@
+name: Fetch News Files
+
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Run daily at midnight UTC
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  fetch-news:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: autodocs
+
+      - name: Run news fetcher
+        run: |
+          chmod +x docs/scripts/fetch-news.sh
+          ./docs/scripts/fetch-news.sh
+
+      - name: Commit and push if changes exist
+        run: |
+          git config --global user.name 'GitHub Actions Bot'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add docs/news/
+          git diff --quiet && git diff --staged --quiet || (git commit -m "Auto-update news files" && git push origin autodocs)

.github/workflows/generate-changelog.yml

@@ -1,30 +1,50 @@
-name: Generate Changelog
+name: Update Changelog
+
 on:
-    push:
-        tags:
-            - "*"
+  release:
+    types: [published]
+
 jobs:
-    changelog:
-        runs-on: ubuntu-latest
-        permissions:
-            contents: write
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  ref: main
-                  token: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
-            - name: Generate Changelog
-              run: |
-                  export PATH="$PATH:/home/runner/.local/share/gem/ruby/3.0.0/bin"
-                  gem install --user-install github_changelog_generator
-                  github_changelog_generator \
-                    -u ${{ github.repository_owner }} \
-                    -p ${{ github.event.repository.name }} \
-                    --token ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
-            - name: Commit Changelog
-              uses: stefanzweifel/git-auto-commit-action@v5
-              with:
-                  commit_message: "chore: update changelog"
-                  branch: main
-                  file_pattern: "CHANGELOG.md"
-                  commit_author: "GitHub Action <actions@github.com>"
+  update_changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Configure Git
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "actions@github.com"
+
+      - name: Check if autodocs branch exists and create or switch to it
+        run: |
+          if git ls-remote --heads origin autodocs | grep autodocs; then
+            echo "Branch autodocs exists, checking out"
+            git checkout autodocs
+            git pull origin autodocs
+          else
+            echo "Branch autodocs doesn't exist, creating"
+            git checkout -b autodocs
+          fi
+
+      - name: Generate changelog
+        run: python3 docs/scripts/get-changelog.py --output docs/docs/changelog.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}
+
+      - name: Commit and push changes
+        run: |
+          git add docs/changelog.md
+          git commit -m "docs: update changelog for ${{ github.event.release.tag_name }}" || echo "No changes to commit"
+          git push origin autodocs
+        env:
+          GITHUB_TOKEN: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -1,10 +1,10 @@
-# Contributing to Eliza
+# Contributing to eliza
 
-First off, thank you for considering contributing to Eliza! We welcome contributions from everyone, regardless of experience level.
+First off, thank you for considering contributing to eliza! We welcome contributions from everyone, regardless of experience level.
 
 ## Contribution License Agreement
 
-By contributing to Eliza, you agree that your contributions will be licensed under the MIT License. This means:
+By contributing to eliza, you agree that your contributions will be licensed under the MIT License. This means:
 
 1. You grant us (and everyone else) a perpetual, worldwide, non-exclusive, royalty-free license to use your contributions.
 2. Your contributions are and will be available as Free and Open Source Software (FOSS).
@@ -20,11 +20,13 @@ We believe in the power of the OODA Loop - a decision-making framework that emph
 - **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
 - **Act**: Execute your decision and share your work with the community.
 
+---
+
 ## How to Contribute
 
 ### For Developers
 
-1. **Extend Eliza's Capabilities**
+1. **Extend eliza's Capabilities**
 
     - Develop new actions, evaluators, and providers
     - Improve existing components and modules
@@ -44,6 +46,60 @@ We believe in the power of the OODA Loop - a decision-making framework that emph
 6. Make sure your code lints.
 7. Issue that pull request!
 
+### For Designers
+
+1. **Improve User Experience**
+
+    - Conduct user research and usability testing
+    - Design intuitive user interfaces and interactions
+    - Create high-fidelity mockups and prototypes
+
+2. **Enhance Visual Design**
+    - Develop a consistent visual language and style guide
+    - Create engaging illustrations, icons, and graphics
+    - Optimize designs for accessibility and inclusivity
+
+### For Writers and Storytellers
+
+1. **Craft Compelling Narratives**
+
+    - Write blog posts, articles, and stories that communicate our vision
+    - Develop characters and scenarios that showcase the potential of AI agents
+    - Collaborate with artists to create immersive, multimedia experiences
+
+2. **Improve Documentation**
+    - Write clear, concise, and accessible documentation
+    - Create tutorials, guides, and FAQs to help users get started
+    - Provide examples and use cases to demonstrate eliza's capabilities
+
+### For Artists and Creators
+
+1. **Illustrate the Future**
+
+    - Create concept art, illustrations, and infographics that bring our vision to life
+    - Design characters, avatars, and virtual environments for AI agents
+    - Experiment with new mediums and formats to communicate ideas
+
+2. **Produce Multimedia Content**
+    - Create videos, animations, and interactive experiences
+    - Develop podcasts, interviews, and audio content
+    - Collaborate with writers and developers to create integrated campaigns
+
+### For Community Builders
+
+1. **Foster Engagement**
+
+    - Moderate forums, chat rooms, and social media channels
+    - Organize events, meetups, and hackathons
+    - Facilitate discussions and collaborations among contributors
+
+2. **Provide Support**
+    - Answer questions and provide guidance to new contributors
+    - Triage issues and help prioritize bug fixes and feature requests
+    - Act as a liaison between the community and the core development team
+
+---
+
 ## Styleguides
 
 ### Git Commit Messages
@@ -90,7 +146,7 @@ This section lists the labels we use to help us track and manage issues and pull
 
 ## Contributor Guide
 
-Welcome to the Eliza contributor guide! This document is designed to help you understand how you can be part of building the future of autonomous AI agents, regardless of your technical background.
+Welcome to the eliza contributor guide! This document is designed to help you understand how you can be part of building the future of autonomous AI agents, regardless of your technical background.
 
 ### Code of Conduct
 
@@ -126,4 +182,4 @@ Project maintainers have the right and responsibility to remove, edit, or reject
 
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
 
-Thank you for contributing to Eliza and helping build the future of autonomous AI agents! 🎉
+Thank you for contributing to eliza and helping build the future of autonomous AI agents! 🎉