Skip to content

Commit 415e00a

Browse files
author
FolderView Plus Test
committed
Reorganize repository docs layout
1 parent 6953cc1 commit 415e00a

10 files changed

Lines changed: 35 additions & 10 deletions

File tree

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ bash scripts/unraid_matrix_smoke.sh
4646

4747
- Include a clear summary of what changed and why.
4848
- Include screenshots for UI changes (desktop and mobile when relevant).
49-
- Update docs (`README.md`, `CHANGELOG-fixes.md`, or language files) when behavior changes.
49+
- Update docs (`README.md`, `docs/CHANGELOG.md`, or language files) when behavior changes.
5050
- Keep backwards compatibility unless the change is intentional and documented.
5151

5252
## Coding Standards
File renamed without changes.
File renamed without changes.

.github/workflows/ci.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,10 @@ jobs:
5757
docs:
5858
- 'README.md'
5959
- 'docs/**'
60-
- 'CHANGELOG-fixes.md'
61-
- 'CONTRIBUTING.md'
6260
- 'LICENSE.md'
63-
- 'SECURITY.md'
64-
- 'SUPPORT*.md'
61+
- '.github/CONTRIBUTING.md'
62+
- '.github/SECURITY.md'
63+
- '.github/SUPPORT*.md'
6564
- 'src/folderview.plus/usr/local/emhttp/plugins/folderview.plus/README.md'
6665
metadata:
6766
- 'folderview.plus.plg'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
FolderView Plus gives Unraid a cleaner, folder-first way to manage Docker containers, VMs, and Dashboard views.
1919
It is built for real libraries: easier organization, smarter setup, safer recovery, and clearer runtime diagnostics.
2020

21-
Quick links: [Install](#install) | [What It Does](#what-it-does) | [Settings Overview](#settings-overview) | [Rules Quick Guide](#rules-quick-guide) | [Bulk Assignment Quick Guide](#bulk-assignment-quick-guide) | [Backups and Recovery](#backups-and-recovery) | [Troubleshooting](#troubleshooting) | [Theme Guide](docs/THEME_GUIDE.md) | [Support Policy](SUPPORT_POLICY.md)
21+
Quick links: [Install](#install) | [What It Does](#what-it-does) | [Settings Overview](#settings-overview) | [Rules Quick Guide](#rules-quick-guide) | [Bulk Assignment Quick Guide](#bulk-assignment-quick-guide) | [Backups and Recovery](#backups-and-recovery) | [Troubleshooting](#troubleshooting) | [Theme Guide](docs/THEME_GUIDE.md) | [Support Policy](docs/SUPPORT_POLICY.md) | [Docs Index](docs/README.md)
2222

2323
## Screenshots
2424

@@ -343,7 +343,7 @@ File naming rules:
343343

344344
Stable selector and migration policy:
345345

346-
- [SUPPORT_POLICY.md](SUPPORT_POLICY.md)
346+
- [docs/SUPPORT_POLICY.md](docs/SUPPORT_POLICY.md)
347347

348348
Recommended migration path:
349349

File renamed without changes.

docs/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# FolderView Plus Docs
2+
3+
This folder holds project documentation that does not need to stay at the repository root.
4+
5+
## Core Docs
6+
7+
- [CHANGELOG.md](CHANGELOG.md)
8+
- [SUPPORT_POLICY.md](SUPPORT_POLICY.md)
9+
- [THEME_GUIDE.md](THEME_GUIDE.md)
10+
- [THEME_API_CONTRACT.md](THEME_API_CONTRACT.md)
11+
12+
## Architecture
13+
14+
- [docker-runtime-architecture.md](docker-runtime-architecture.md)
15+
- [vm-runtime-architecture.md](vm-runtime-architecture.md)
16+
- [visual-runtime-contract.md](visual-runtime-contract.md)
17+
18+
## Testing and Assets
19+
20+
- [edge-cases-test-matrix.md](edge-cases-test-matrix.md)
21+
- [images/README.md](images/README.md)
22+
- [images/screenshots/README.md](images/screenshots/README.md)
23+
24+
## Releases
25+
26+
- Versioned release notes live in [`releases/`](releases/).
File renamed without changes.

scripts/ensure_plg_changes_entry.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ classify_changed_path_subsystems() {
280280
esac
281281

282282
case "${changed}" in
283-
README.md|docs/*|CHANGELOG-fixes.md|SECURITY.md|SUPPORT*.md|CONTRIBUTING.md|src/folderview.plus/usr/local/emhttp/plugins/folderview.plus/README.md)
283+
README.md|docs/*|.github/SECURITY.md|.github/SUPPORT*.md|.github/CONTRIBUTING.md|src/folderview.plus/usr/local/emhttp/plugins/folderview.plus/README.md)
284284
printf '%s\n' "docs"
285285
return
286286
;;

tests/support-policy-contract.test.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import fs from 'node:fs';
44
import path from 'node:path';
55

66
const repoRoot = path.resolve(process.cwd());
7-
const supportPolicyPath = path.join(repoRoot, 'SUPPORT_POLICY.md');
7+
const supportPolicyPath = path.join(repoRoot, 'docs', 'SUPPORT_POLICY.md');
88
const readmePath = path.join(repoRoot, 'README.md');
99

1010
const supportPolicy = fs.readFileSync(supportPolicyPath, 'utf8');
@@ -27,7 +27,7 @@ test('support policy documents selector contracts and deprecation window', () =>
2727

2828
test('readme links to support policy from legacy migration section', () => {
2929
assert.match(readme, /Legacy CSS\/JS Migration \(FolderView2\/3\)/);
30-
assert.match(readme, /SUPPORT_POLICY\.md/);
30+
assert.match(readme, /docs\/SUPPORT_POLICY\.md/);
3131
});
3232

3333
test('readme documents v2 support bundle preview and sanitized redaction defaults', () => {

0 commit comments

Comments
 (0)