Skip to content

Consolidate documentation under lowercase docs#334

Merged
AnkushMalaker merged 1 commit into
devfrom
docs/consolidate-documentation
Jul 14, 2026
Merged

Consolidate documentation under lowercase docs#334
AnkushMalaker merged 1 commit into
devfrom
docs/consolidate-documentation

Conversation

@AnkushMalaker

Copy link
Copy Markdown
Collaborator

Summary

  • rename CLAUDE.md to the agent-neutral AGENTS.md
  • consolidate project and backend references under a single lowercase docs/ tree
  • add docs/README.md as the canonical documentation index
  • remove stale backend documentation that duplicated or conflicted with current architecture
  • update tracked links, setup output, templates, and source references to the canonical paths

Removed stale documentation

  • backend documentation index and malformed contribution reading list
  • obsolete backend architecture and flow diagram
  • outdated dashboard and speaker enrollment guides

Focused auth, memory, plugin, initialization, deployment, SSL, overview, and audio-pipeline documentation remains in docs/.

Validation

  • pre-commit run --files <changed files>
  • git diff --check
  • verified no tracked references remain to CLAUDE.md, Docs/, or backends/advanced/Docs/
  • verified local links in the canonical documentation and changed files resolve

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2706c75e-ce03-49cf-9a39-7f791e70b2de

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/consolidate-documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AnkushMalaker
AnkushMalaker merged commit 7b88ff6 into dev Jul 14, 2026
1 of 2 checks passed
@github-actions

Copy link
Copy Markdown

⚠️ Robot Framework Test Results (No API Keys)

Status: ❌ Some tests failed

ℹ️ Note: This run excludes tests requiring external API keys (Deepgram, OpenAI).
Tests tagged with requires-api-keys will run on dev/main branches.

Metric Count
✅ Passed 108
❌ Failed 22
📊 Total 130

📊 View Reports

GitHub Pages (Live Reports):

Download Artifacts:


View full workflow run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant