Skip to content

Commit 14367f4

Browse files
committed
docs: remove architecture-heavy landing page text
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent c3f1666 commit 14367f4

3 files changed

Lines changed: 2 additions & 35 deletions

File tree

docs/README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,3 @@
44
# Documentation folder layout
55

66
This folder is intentionally split to isolate source content from generated output.
7-
8-
## Structure
9-
10-
- `docs/source/`: documentation source files maintained by contributors and intended for publication.
11-
- `docs/site/`: generated static site output (build artifact, not versioned).
12-
13-
The public entry page is `docs/index.md`.
14-
15-
## Rules
16-
17-
- Keep hand-written documentation in `docs/source/`.
18-
- Never commit generated files under `docs/site/`.
19-
- Build outputs in root `site/` are also ignored to reduce accidental commits.
20-
21-
If a docs tool is reintroduced in the future, configure it to read from `docs/source/` and write to `docs/site/`.

docs/index.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33

44
# xobject-template documentation
55

6-
This is the front door for the public docs site.
7-
8-
If you're a developer trying to use `xobject-template`, start with the install guide, then open an example, then check a real use case.
6+
Read the docs.
97

108
`xobject-template` compiles a constrained HTML/CSS subset into PDF Form XObject output.
119

@@ -15,13 +13,6 @@ If you're a developer trying to use `xobject-template`, start with the install g
1513
- [Examples](source/reference/)
1614
- [Visible signature use case](source/use-cases/)
1715

18-
## Repository layout
19-
20-
- `src/` — library code
21-
- `tests/` — unit, integration, and documentation tests
22-
- `docs/` — public documentation pages
23-
- `docs/source/` — editable source pages and examples
24-
2516
## Quick example
2617

2718
```php

docs/source/index.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33

44
# xobject-template documentation
55

6-
Editable source for the public docs site.
7-
8-
Use this folder when you want to update the pages that get published.
6+
Docs content.
97

108
`xobject-template` compiles a constrained HTML/CSS subset into PDF Form XObject output.
119

@@ -15,13 +13,6 @@ Use this folder when you want to update the pages that get published.
1513
- [Examples](reference/)
1614
- [Visible signature use case](use-cases/)
1715

18-
## Repository layout
19-
20-
- `src/` — library code
21-
- `tests/` — unit, integration, and documentation tests
22-
- `docs/source/` — documentation pages intended for publication
23-
- `docs/source/examples/` — executable examples with fixtures
24-
2516
## Quick example
2617

2718
```php

0 commit comments

Comments
 (0)