mirror of https://github.com/raandree/NTFSSecurity
Browse Source
- Decision 9: keep the documentation on GitHub; no Read the Docs site, and the wiki is retired. Decision 4 now rests on it. - Work package 3 redefined and PR-ready; work package 4 decisions: PowerShellVersion 5.1, DotNetFrameworkVersion 4.5.2, RootModule, and 5.0.0 with the PassThur alias. - Correct the Windows PowerShell 5.1 recipe (don't clear PSModulePath), and record the local build from the NuGet cache, the link-check limits, and the deleted fork behind the Read the Docs project. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: AI Assistant <ai@example.com>pull/94/head
7 changed files with 130 additions and 74 deletions
@ -0,0 +1,25 @@ |
|||
--- |
|||
status: accepted |
|||
date: 2026-10-04 |
|||
last-verified: 2026-10-04 |
|||
owner: shared |
|||
source: maintainer decision in work package 3 |
|||
--- |
|||
|
|||
# Decision 9: Keep the documentation on GitHub |
|||
|
|||
- Choice: The documentation lives in `Docs` and `README.md`, and GitHub |
|||
renders it. There is no documentation site: the Read the Docs and MkDocs |
|||
configuration is removed. The GitHub wiki is retired: its version history |
|||
and installation steps moved to `Docs/Version-History.md` and |
|||
`Docs/README.md`, and the maintainer turns the wiki off. |
|||
- Rationale: One source of truth that is versioned with the code, reviewed |
|||
in pull requests, and checked by AppVeyor. The Read the Docs project |
|||
`ntfssecurity` belongs to `Sup3rlativ3` and points to a fork that no |
|||
longer exists; a wiki is edited outside pull requests and CI. |
|||
- Consequences: `online version` links stay on GitHub (Decision 4). Section |
|||
anchors follow GitHub's rules. `Docs/index.md` became `Docs/README.md`, so |
|||
that GitHub shows it when you open the `Docs` folder. |
|||
- Rejected: taking over or re-importing the Read the Docs project with a |
|||
strict MkDocs build (prepared on the local branch `ai/read-the-docs`, not |
|||
merged), and publishing `Docs` to the wiki. |
|||
Loading…
Reference in new issue