Skip to content
AutoCore1.0.0-rc.1 · Release Candidate
1.0.0-rc.1 · Release Candidate3 min read

Documentation Map

Choose the right AutoCore documentation path for installation, administration, operations, development, or security review.

AutoCore documentation is organized by the decisions a reader needs to make. Start with the shared concepts, then use the role-specific sections as they become available.

Choose a starting point

You are a…Start withThen continue with
Installation operatorInstallation conceptInstallation, configuration, upgrade, and recovery sections
Admin userApplication SurfacesAdmin Guide and Marketplace Operations
DeveloperApplication SurfacesDeveloper Guide, API Reference, and validation/contracts
System administratorInstallation conceptArchitecture, Operations, Integrations, and Troubleshooting
Security reviewerProduct StatusSecurity, configuration boundaries, audit logging, and backup security
Commercial buyerOverviewProduct Status, capabilities, limitations, and authorized delivery information
Support or maintenance personnelTerminologyTroubleshooting, service health, logs, backups, and recovery

Planned section hierarchy

The complete AutoCore information architecture is recorded in the internal governance plan and coverage matrix. The public site activates pages only after they have content and source verification.

Core sections

  • Start Here — overview, status, audience paths, documentation map, and terminology.
  • Concepts — installation identity, edition behavior, primary market, applications, listing lifecycle, search, policies, consent, and payment states.
  • Architecture — application topology, request flow, data stores, workers, media, isolation, configuration, and security boundaries.
  • Installation — requirements, package, configuration, preflight, first administrator, verification, manifest, and clean-install checklist.
  • Configuration — domains, locale, currency, timezone, units, vehicle capabilities, media, search, notifications, payments, legal entity, consent, headers, backups, and monitoring.
  • Upgrade and Recovery — supported paths, preflight, backups, upgrade verification, interrupted recovery, rollback, and restore decisions.

Operational sections

  • Admin Guide — users, roles, catalog, listings, dealers, media, legal, consent, payments, audit, and health.
  • Marketplace Operations — review, publication, onboarding, moderation, market configuration, and maintenance.
  • Integrations — PostgreSQL, Redis, Meilisearch, media storage, SMTP, SMS, Stripe, webhooks, proxy, and monitoring.
  • Security — authentication, authorization, sessions, secrets, webhooks, containers, backups, audit logs, headers, vulnerabilities, and incidents.
  • Operations — topology, health, logs, monitoring, backups, restore decisions, workers, search, media, proxy, disk, maintenance, and incidents.

Engineering and reference sections

  • Developer Guide — repository structure, applications, packages, schema, contracts, editions, testing, builds, images, CI, release, and extension points.
  • API Reference — authentication, errors, pagination, rate limits, public/admin/setup/legal/payment endpoints, webhooks, health, and OpenAPI.
  • Troubleshooting — installer, images, architecture, ports, dependencies, proxy, migrations, setup state, worker, media, search, payments, policies, and backups.
  • Reference — schemas, environment variables, installer commands, exit codes, manifests, services, ports, permissions, states, glossary, platforms, and limitations.
  • Release Notes — RC notes, upgrade notes, breaking changes, deprecations, and release inventory.

Localization path

English is the primary language for this phase. The content model is product- and version-scoped, so a future Turkish locale can be added without duplicating the current English routes or changing the AutoCore source contracts. Turkish localization is not implemented in this phase.

Related articles