### Chapter: README (docs/README.md) # Countly Server Documentation Index This README provides a table of contents for all markdown documentation files in the repository, including those in the root, docs, .github, plugins, bin, and other folders. --- ## Top-Level Documentation - [README.md](../README.md): Project overview, installation, and quick links. - [CODING_GUIDELINES.md](../CODING_GUIDELINES.md): General coding standards and best practices. - [CHANGELOG.md](../CHANGELOG.md): Summary of user-facing changes and releases. - [CONTRIBUTING.md](../CONTRIBUTING.md): How to contribute to Countly Server. - [SECURITY.md](../SECURITY.md): (Legacy) Security guidelines. - [CLAUDE.md](../CLAUDE.md): Claude-specific notes. ## docs/ Folder - [README.md](README.md): This documentation index. - [SECURITY.md](SECURITY.md): Security requirements and best practices. - [VUEJS_GUIDELINES.md](VUEJS_GUIDELINES.md): Vue.js frontend development standards. - [CSS_STYLE_GUIDE.md](CSS_STYLE_GUIDE.md): SASS, BEM, and Bulma CSS conventions. - [UI_TESTING.md](UI_TESTING.md): Cypress UI testing and data-test-id usage. - [OBSERVABILITY_GUIDELINES.md](OBSERVABILITY_GUIDELINES.md): Logging, debugging, and error reporting standards. ## .github/ Folder - [AI_PR_REVIEW_GUIDELINES.md](../.github/AI_PR_REVIEW_GUIDELINES.md): Guidelines for AI-based PR review bots. - [issue_template.md](../.github/issue_template.md): Issue template for GitHub. - [copilot-instructions.md](../.github/copilot-instructions.md): Copilot agent instructions. ## test/ Folder - [README.md](../test/README.md): Test suite documentation and instructions. ## ui-tests/ Folder - [README.md](../ui-tests/README.md): UI test suite documentation. ## bin/ Folder - [README.md](../bin/README.md): Installation scripts documentation. - [scripts/README.md](../bin/scripts/README.md): Bin scripts documentation. - [scripts/sharding/README.md](../bin/scripts/sharding/README.md): Sharding scripts documentation. - [upgrade/18.08/mongo.upgrade.instructions.md](../bin/upgrade/18.08/mongo.upgrade.instructions.md): Mongo upgrade instructions. ## api/parts/jobs/ Folder - [README.md](../api/parts/jobs/README.md): Jobs system documentation. - [job_flow.md](../api/parts/jobs/job_flow.md): Job flow documentation. ## plugins/guides/ Folder - [README.md](../plugins/guides/README.md): Plugin guides documentation. ## Other Markdown Files - Any other .md files found in the repository can be referenced directly by their path. --- **Tip:** For coding standards, always start with [CODING_GUIDELINES.md](../CODING_GUIDELINES.md). For specialized topics, see the relevant docs above.