Note: This documentation is for version 0.1.3-alpha of Accellens — AI Accessibility Compliance Platform. 🚧 Work in Progress (WIP) 🚧 For general project overview, quick start, and repository structure, see root README.md.
accellens/
├─ README.md # Project overview, quick start, structure
├─ .github/
│ ├─ COMMIT_MESSAGE.md # Commit message guidelines
│ ├─ actions/ # GitHub Actions
│ │ └─ accellens-scan/ # Accellens scan action
│ └─ workflows/ # GitHub workflows
│ └─ accellens-scan-example.yml
├─ .circleci/ # CircleCI integration
│ └─ accellens-scan.yml
├─ .gitlab-ci/ # GitLab CI integration
│ └─ accellens-scan.yml
├─ ci-cd/ # CI/CD integrations
│ ├─ azure-pipelines/ # Azure DevOps integration
│ ├─ bamboo/ # Bamboo integration
│ ├─ bitbucket-pipelines/ # Bitbucket Pipelines integration
│ ├─ jenkins/ # Jenkins integration
│ └─ teamcity/ # TeamCity integration
└─ docs/
├─ INDEX.md # Documentation index (this file)
│
├─ product/ # Product Requirements
│ ├─ PRD.md # Product Requirements Document
│ └─ roadmap.md # Product roadmap
│
├─ architecture/ # System architecture
│ ├─ architecture.md # High-level architecture
│ ├─ data-model.md # Data schema
│ ├─ scan-api-extensibility.md # Scan API extensibility
│ ├─ guided-setup-ui.md # Guided Setup UI architecture
│ ├─ project-context-migration.md # Migration plan: project context in header
│ ├─ guidepup-saas-architecture.md # Guidepup architecture for SaaS
│ ├─ multi-session-support.md # Multi-session support architecture
│ └─ feature-flags.md # Feature Flags architecture
│
├─ api/ # API documentation
│ ├─ api-reference.md # REST and GraphQL API
│ ├─ cli-reference.md # CLI reference
│ ├─ allure-format.md # Allure JSON format
│ └─ error-handling.md # API error handling
│
├─ development/ # Developer guides
│ ├─ developer-guide.md # Developer's Guide (main document)
│ ├─ router-validation.md # Router validation and dependency checking
│ ├─ design-system.md # Design System (UI/UX, components, styles)
│ ├─ coding-standards.md # Coding standards and quality
│ ├─ audit-engine-rules.md # Rules sources and update process documentation
│ ├─ custom-rules-guide.md # Custom rules creation guide
│ ├─ esm-import-guidelines.md # ESM imports guidelines
│ ├─ infrastructure-restart-guide.md # Infrastructure restart guide
│ ├─ docker-compose-best-practices.md # Docker Compose best practices and troubleshooting
│ ├─ docker-compose-prevention-checklist.md # Docker Compose problem prevention checklist
│ ├─ ai-providers.md # Working with AI providers
│ ├─ agent-instructions.md # Agent developer instructions
│ ├─ i18n-guide.md # Internationalization guide
│ ├─ aliases-cheatsheet.md # Alias commands cheatsheet
│ ├─ shell-aliases.md # Shell alias setup
│ ├─ version-management.md # Version management (Docker and CI/CD sync)
│ ├─ docs-smoke-tests.md # Documentation verification automation plan
│ ├─ sonarqube-setup.md # SonarCloud setup for code quality analysis
│ ├─ sonarqube-quality-gates.md # SonarCloud Quality Gates setup
│ ├─ sonarqube-metrics-dashboards.md # SonarCloud metrics and dashboards setup
│ ├─ sonarqube-results-interpretation.md # SonarQube results interpretation and code smell fixes
│ ├─ local-code-analysis.md # Local code analysis (SonarQube alternatives)
│ └─ logging-guide.md # Logger usage guide
│
├─ testing/ # Testing
│ ├─ testing.md # Testing strategy
│ ├─ test-plan.md # Test plan
│ ├─ parallel-test-execution.md # Parallel test execution
│ ├─ test-performance-monitoring.md # Test performance monitoring
│ └─ scanner-kpi.md # Web scanner KPIs (dataset, automation, metrics)
│
├─ deployment/ # Deployment and operations
│ ├─ deployment.md # Release strategy and environments
│ ├─ setup.md # Installation and setup
│ ├─ infrastructure.md # Infrastructure deployment (Terraform)
│ ├─ observability.md # Observability setup (OpenTelemetry, Prometheus, Grafana)
│ ├─ security.md # Security baseline (safety filters, PII, audit logging)
│ ├─ security-audit-process.md # Security audit process (monthly triage + quarterly review)
│ ├─ environment-variables.md # Environment variables
│ ├─ SSO-QUICKSTART.md # SSO quick setup (OIDC/SAML)
│ ├─ sso-setup.md # Complete SSO setup documentation
│ ├─ ci-cd-verification.md # CI/CD and DevOps verification guide
│ ├─ runbooks.md # Recovery procedures and incidents
│ ├─ rollback-drills.md # Rollback drills guide
│ ├─ mvp-readiness-check.md # Automated MVP release readiness check
│ └─ logging-retention.md # Log retention policies
│
├─ integrations/ # Integrations
│ ├─ github-actions.md # GitHub Actions and CI/CD
│ ├─ gitlab-ci.md # GitLab CI/CD
│ ├─ jenkins.md # Jenkins
│ ├─ bamboo.md # Bamboo integration
│ ├─ circleci.md # CircleCI
│ ├─ teamcity.md # TeamCity integration
│ ├─ azure-devops.md # Azure DevOps Pipelines
│ └─ bitbucket-pipelines.md # Bitbucket Pipelines
│
├─ operations/ # Operational guides
│ ├─ impacted-users-migration.md # Backward compatibility for impacted_users field
│ ├─ runbook.md # Operational runbook
│ └─ tracing-best-practices.md # Distributed tracing best practices
│
└─ contributing/ # Contributing
└─ contributing.md # Contribution rules, RFC process
- Read developer-guide.md
- Study architecture.md and data-model.md
- Set up environment using setup.md and deployment.md
- Review standards from coding-standards.md
- Read COMMIT_MESSAGE.md for commit format
- Save aliases-cheatsheet.md - alias commands cheatsheet
- agent-instructions.md - Critical: Instructions for working with roadmap and code
- roadmap.md - Product roadmap with tasks and dependencies
- developer-guide.md - Developer guide
- developer-guide.md
- architecture.md
- multi-session-support.md
- api-reference.md
- error-handling.md
- ai-providers.md
- testing.md
- developer-guide.md
- design-system.md - Critical: Design System, UI/UX components, styles
- architecture.md
- developer-guide.md#5-experience-layer - Frontend dashboard and Experience Layer
- coding-standards.md
- testing.md
- setup.md
- deployment.md
- infrastructure.md - Infrastructure deployment with Terraform
- cdn.md - CDN configuration and deployment
- observability.md - Observability setup (OpenTelemetry, Prometheus, Grafana)
- security.md - Security baseline (safety filters, PII, audit logging)
- security-audit-process.md - Security audit process (monthly triage + quarterly review)
- logging-guide.md - Logger usage guide
- logging-retention.md - Log retention policies
- environment-variables.md
- SSO-QUICKSTART.md - SSO quick setup (OIDC/SAML)
- ci-cd-verification.md - CI/CD and DevOps verification guide
- runbooks.md - Recovery procedures and H0 on-call playbook
- rollback-drills.md - Rollback drills guide
- mvp-readiness-check.md - Automated MVP release readiness check
- developer-guide.md#111-utilities-and-scripts - Utilities and automation scripts
- github-actions.md
- gitlab-ci.md
- jenkins.md
- bamboo.md
- circleci.md
- teamcity.md
- azure-devops.md
- bitbucket-pipelines.md
- testing.md#25-performance--load - Load testing
- load-testing-k6.md - Load testing (k6) quick start
- a11y-e2e-playwright-axe.md - E2E accessibility checks (Playwright + axe)