Skip to content

Commit e379713

Browse files
committed
Add comprehensive documentation for Better Together Community Engine
- Introduced new guides for end users, platform organizers, support staff, and legal compliance. - Created a development setup guide for contributors to run the Community Engine locally. - Implemented a script to generate PDFs from markdown documentation, including a customizable LaTeX header. - Added community guidelines, privacy policy, and safety reporting tools for end users. - Enhanced existing documentation with updated links and references for better navigation. - Established a structured approach for user support procedures and compliance/legal guidelines for platform organizers.
1 parent 80d00a4 commit e379713

37 files changed

+16422
-19
lines changed

Dockerfile.docs

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# syntax=docker/dockerfile:1.7
2+
3+
# Minimal toolchain for generating the documentation PDF (pandoc + LaTeX).
4+
FROM debian:12-slim
5+
6+
ARG DEBIAN_FRONTEND=noninteractive
7+
8+
RUN set -eux; \
9+
apt-get update -qq; \
10+
apt-get install -y --no-install-recommends \
11+
ca-certificates \
12+
curl \
13+
lmodern \
14+
fonts-noto-core \
15+
fonts-noto-mono \
16+
fonts-noto-cjk \
17+
fonts-noto-color-emoji \
18+
pandoc \
19+
texlive-latex-base \
20+
texlive-latex-recommended \
21+
texlive-fonts-recommended \
22+
texlive-xetex \
23+
fontconfig \
24+
fonts-dejavu-core; \
25+
rm -rf /var/lib/apt/lists/*
26+
27+
# Drop root for runtime safety
28+
RUN groupadd --system docs \
29+
&& useradd --system --create-home --gid docs --shell /bin/bash docs
30+
31+
WORKDIR /workspace
32+
USER docs
33+
34+
ENV LANG=C.UTF-8 \
35+
LC_ALL=C.UTF-8

build/docs/combined.md

Lines changed: 10064 additions & 0 deletions
Large diffs are not rendered by default.
38.4 KB
Binary file not shown.
19.7 KB
Binary file not shown.
354 KB
Binary file not shown.
37.3 KB
Binary file not shown.
19.3 KB
Binary file not shown.
42.5 KB
Binary file not shown.
19.8 KB
Binary file not shown.
658 KB
Binary file not shown.

0 commit comments

Comments
 (0)