Skip to content

Commit fd8f030

Browse files
chore: sync READMEs from source repos
1 parent 521962c commit fd8f030

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

docs/projects/docs-templates.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,32 @@ If you already have a MkDocs site and want to add the Plex guide:
8989
# ... see Variable Reference below
9090
```
9191

92-
4. **Copy `plex-guide/docs/index.md`** into your docs directory.
92+
4. **Copy the template pages** into your docs directory:
93+
94+
```bash
95+
cp plex-guide/docs/index.md your-docs/guides/plex/index.md
96+
cp plex-guide/docs/device-setup.md your-docs/guides/plex/device-setup.md
97+
```
98+
99+
If using as a git submodule, add these `cp` commands to your build pipeline (Docker entrypoint, CI workflow, or `make build` target). The template is the source of truth — don't edit the local copies.
93100

94101
5. **Add `render_macros: true`** to the page's frontmatter (already included in the template).
95102

103+
6. **Configure `admin_contact` as a cross-page link** if you use multiple template pages. The `#contact-aj` anchor only exists on `index.md`, so use:
104+
105+
```yaml
106+
admin_contact: "[Contact Admin](index.md#contact-aj)"
107+
```
108+
109+
Using a same-page anchor like `[Contact Admin](#contact-aj)` will fail the mkdocs build in strict mode when the macro expands on `device-setup.md`.
110+
111+
7. **Gitignore the local copies** so they're always sourced from the template:
112+
113+
```gitignore
114+
docs/guides/plex/index.md
115+
docs/guides/plex/device-setup.md
116+
```
117+
96118
## Variable Reference
97119

98120
### Required

0 commit comments

Comments
 (0)