Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
bd4b5f6
docs: add tested user docs site and github pages deploy
vitormattos Jun 1, 2026
271fecd
docs: remove duplicate PR template and reduce contributing overlap
vitormattos Jun 1, 2026
315c860
docs: switch to minimal maintenance mode
vitormattos Jun 1, 2026
1e061a9
docs: isolate sources under docs/source and ignore docs/site outputs
vitormattos Jun 1, 2026
34bc1b0
docs: move examples to docs/source/examples with updated path references
vitormattos Jun 1, 2026
8bfdcbe
chore: remove unecessary template
vitormattos Jun 1, 2026
f06ecb0
docs: restore minimal public documentation pages
vitormattos Jun 1, 2026
39f9b08
docs: simplify documentation landing pages
vitormattos Jun 1, 2026
c3f1666
docs: clarify documentation landing pages
vitormattos Jun 1, 2026
14367f4
docs: remove architecture-heavy landing page text
vitormattos Jun 1, 2026
c09655f
docs: trim examples reference page
vitormattos Jun 1, 2026
5e95e93
docs: simplify public docs summary
vitormattos Jun 1, 2026
fbbedae
docs: remove redundant reference index page
vitormattos Jun 1, 2026
2649c76
docs: remove redundant use-cases index page
vitormattos Jun 1, 2026
8650dae
docs: remove redundant guides index page
vitormattos Jun 1, 2026
4c0ae06
docs: remove duplicate source/index.md
vitormattos Jun 1, 2026
9b48b27
docs: add MkDocs build and GitHub Pages deployment
vitormattos Jun 1, 2026
6226768
docs: flatten docs/source/ into docs/ root
vitormattos Jun 1, 2026
305aa5d
docs: move mkdocs config to docs/ and deploy to gh-pages branch
vitormattos Jun 1, 2026
5e43208
chore: remove stale /site/ entry from .gitignore
vitormattos Jun 1, 2026
3be90d0
docs: fix site_dir outside docs_dir and remove conflicting README
vitormattos Jun 1, 2026
60aafd2
docs: enable pygments syntax highlighting
vitormattos Jun 1, 2026
87805e3
docs: move mkdocs config back to project root
vitormattos Jun 1, 2026
51a0439
docs: reorganize to docs/source/ structure for cleaner separation
vitormattos Jun 1, 2026
6971676
docs: fix site_dir path for docs/ config location
vitormattos Jun 1, 2026
d7f26b0
docs: refine govbr visible stamp example to match official appearance
vitormattos Jun 1, 2026
a9923d6
test: simplify visible stamp integration scenarios
vitormattos Jun 1, 2026
5bba710
docs: simplify navigation and docs watch defaults
vitormattos Jun 1, 2026
830b6a2
fix: REUSE
vitormattos Jun 1, 2026
3ff433e
fix: cs
vitormattos Jun 1, 2026
27de4c7
fix: remove empty suite
vitormattos Jun 1, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,15 @@ ARG UID=1000
ARG GID=1000

RUN apt-get update \
&& apt-get install -y --no-install-recommends git unzip zip bash curl ca-certificates \
&& apt-get install -y --no-install-recommends git unzip zip bash curl ca-certificates python3 python3-pip python3-venv \
&& rm -rf /var/lib/apt/lists/*

COPY docs/requirements-docs.txt /tmp/requirements-docs.txt

RUN python3 -m venv /opt/docs-venv \
&& /opt/docs-venv/bin/pip install --no-cache-dir -r /tmp/requirements-docs.txt \
&& ln -sf /opt/docs-venv/bin/mkdocs /usr/local/bin/mkdocs

RUN pecl install xdebug \
&& docker-php-ext-enable xdebug

Expand Down
16 changes: 16 additions & 0 deletions .github/.performance/baseline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"version": "1.0.0",
"created_at": "2026-06-01",
"allowed_regression_pct": 25.0,
"stale_threshold_pct": 35.0,
"benchmarks": {
"LibreSign\\XObjectTemplate\\Benchmarks\\CompilerBench::benchSimpleHtml": {
"mean": 0.356085,
"memory_real": 768
},
"LibreSign\\XObjectTemplate\\Benchmarks\\CompilerBench::benchComplexHtml": {
"mean": 1.366,
"memory_real": 1024
}
}
}
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ body:
id: summary
attributes:
label: Summary
description: Provide a short, objective problem statement.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Include exact input and commands.
validations:
required: true
- type: textarea
Expand All @@ -23,3 +25,14 @@ body:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
validations:
required: true
- type: input
id: runtime
attributes:
label: Runtime details
placeholder: PHP version, package version/commit, OS
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ contact_links:
- name: Security disclosure
url: https://github.com/LibreSign/xobject-template/security
about: Please report vulnerabilities privately.
- name: Sponsor maintenance
url: https://github.com/sponsors/LibreSign
about: Funding helps prioritize fixes and compatibility work.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# SPDX-FileCopyrightText: 2026 LibreSign
# SPDX-License-Identifier: AGPL-3.0-or-later

name: Documentation
description: Report documentation errors or suggest improvements
labels: [documentation]
body:
- type: textarea
id: problem
attributes:
label: What is unclear or incorrect?
validations:
required: true
- type: input
id: page
attributes:
label: Affected page/path
placeholder: docs/reference/supported-svg.md
- type: textarea
id: suggestion
attributes:
label: Suggested improvement
description: Keep suggestions objective and user-focused.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,18 @@ body:
id: problem
attributes:
label: Problem statement
description: Describe the user or integration problem first.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Keep scope explicit and include expected API/behavior impact.
validations:
required: true
- type: textarea
id: non_goals
attributes:
label: Non-goals / out of scope
description: Clarify what should not be included.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/rendering_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# SPDX-FileCopyrightText: 2026 LibreSign
# SPDX-License-Identifier: AGPL-3.0-or-later

name: Rendering bug
description: Report a minimal reproducible rendering issue for HTML/CSS/SVG to XObject output
labels: [bug, rendering]
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Describe the rendering issue in one or two sentences.
validations:
required: true
- type: textarea
id: minimal_input
attributes:
label: Minimal HTML/CSS/SVG input
description: Paste the smallest possible input that reproduces the issue.
render: markdown
validations:
required: true
- type: textarea
id: expected_output
attributes:
label: Expected output
validations:
required: true
- type: textarea
id: actual_output
attributes:
label: Actual output
validations:
required: true
- type: textarea
id: payload_details
attributes:
label: Generated content stream/resources (if possible)
description: Include compile result content stream/resources snippet when available.
- type: dropdown
id: affected_area
attributes:
label: Affected area
options:
- text
- PNG/JPEG
- SVG
- layout
- CSS
- interpolation
- placement
validations:
required: true
- type: input
id: php_version
attributes:
label: PHP version
placeholder: '8.2.x'
validations:
required: true
- type: input
id: package_version
attributes:
label: Package version or commit
placeholder: 'composer version, tag, or commit hash'
validations:
required: true
- type: textarea
id: fixture
attributes:
label: Minimal fixture attachment details
description: If possible, attach or describe a minimal fixture file set.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,24 @@
- [ ] Tests added/updated
- [ ] Relevant checks executed

## Documentation

- [ ] Documentation updated
- [ ] Examples updated if public behavior changed
- [ ] Supported HTML/CSS/SVG matrix updated if relevant
- [ ] Documentation drift checks pass

## Performance

- [ ] Performance impact assessed
- [ ] Benchmark threshold still green

## Output integrity

- [ ] No unsupported feature documented as supported
- [ ] No generated build artifacts committed to the source branch
- [ ] LibreSign use case impact considered if relevant

## Compliance

- [ ] DCO sign-off in all commits
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# SPDX-FileCopyrightText: 2026 LibreSign
# SPDX-License-Identifier: AGPL-3.0-or-later

name: docs

on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/docs.yml'

permissions:
contents: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.12'

- name: Install docs dependencies
run: pip install -r docs/requirements-docs.txt

- name: Deploy to gh-pages
run: mkdocs gh-deploy --force --config-file docs/mkdocs.yml
Loading
Loading