Skip to content

Reorganize docs/ folder - separate elizaOS docs from repo docs #45

@madjin

Description

@madjin

Problem

The docs/ folder has two distinct purposes conflated:

  1. Synced elizaOS documentation - from elizaOS/docs repo, used as context for pipelines
  2. Knowledge repo documentation - workflow docs, analysis reports, etc.

Current issues:

  • elizaOS docs haven't been synced since ~August 2025 (stale)
  • No CI/CD to keep them updated
  • Repo-specific docs (like workflow-timings.md) mixed in with synced content

Proposed Structure

docs/                     # Or docs-elizaos/ - synced from elizaOS/docs
  ├── (synced content)
  
docs-internal/            # Or .docs/ or meta/
  ├── workflow-timings.md
  ├── workflow-analysis-report.md
  └── (other repo-specific docs)

Alternatives:

  • temp/ (gitignored) for working docs
  • meta/ for repo documentation
  • Keep in root as WORKFLOW.md etc.

Tasks

  • Add elizaOS/docs sync to sync.yml workflow
  • Decide on folder structure for repo-specific docs
  • Move workflow-timings.md and workflow-analysis-report.md to appropriate location
  • Update any references to docs paths
  • Consider if synced docs should be gitignored (regenerated on sync)

Context

Files to relocate:

Related: Workflow improvements tracked in #44

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions