Skip to content

Latest commit

 

History

History
119 lines (99 loc) · 5.12 KB

File metadata and controls

119 lines (99 loc) · 5.12 KB
title Community documentation
summary Navigation for the public collaborative typesetting platform.
status current
type index
scope community
audience
contributor
operator
coding-agent
topics
documentation
navigation
community
related
docs/community/product/overview.md
docs/community/architecture/overview.md
docs/community/architecture/release-resilience.md
docs/community/architecture/browser-ai-assistant.md
docs/community/architecture/document-processing.md
docs/community/development/setup.md
code_paths
docs/community
distributions/community/help
protocol
web

Community documentation

This directory is the self-contained engineering Wiki for the Community product. It documents the public product model and extension points without assuming a particular company, deployment platform, private package, or Git provider.

All engineering documentation is maintained in English. Localized files under distributions/*/help/ are application Help Center content, not alternate versions of this Wiki.

Start here

Goal Read in this order
Understand the product Product modelGlossary
Understand the system Architecture overview → the relevant context page
Set up a workstation Development setupTesting
Deploy or operate it DeploymentConfiguration
Change an API API guideApplication protocols
Change user-facing Help Distribution configuration → localized files under distributions/community/help/
Change a compiler runtime Typst runtime or LaTeX runtime
Operate or extend durable processing Document processingWorker protocolLaTeX worker
Understand a design choice Decision records

Topic map

Product and architecture

Configuration and runtimes

Development, operations, and reference

Sources of truth

When sources disagree, use this precedence:

  1. generated contracts and executable configuration, including protocol/openapi.json, distribution JSON, manifests, and migrations;
  2. current code and tests in the owning module;
  3. current-reference pages in this Wiki;
  4. accepted decision records, which preserve rationale but do not override an executable contract.

Update the owning page in the same change as behavior, configuration, protocol, runtime, or operational changes. Describe current behavior in present tense, put durable rationale in an ADR, and avoid completed task trackers or migration diaries as reference documentation.

Frontmatter contract

Every managed page uses the same YAML fields: title, summary, status, type, scope, audience, topics, related, and code_paths. scope is part of the retrieval and publication contract, not an informal label. The final prose section is always Related so renderers that ignore frontmatter can still traverse the Wiki.

Related