OEL
/
NTFSSecurity
mirror of https://github.com/raandree/NTFSSecurity
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
316 Commits
6 Branches
10 Tags
12 MiB
 
 
Tree: 26d667a78d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '26d667a78d'
${ noResults }
NTFSSecurity/.memory-bank/decisions/0009-docs-on-github.md

1.5 KiB
Raw Blame History

status date last-verified owner source
accepted 2026-10-04 2026-10-04 shared 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 wiki's version history and installation steps moved to Docs/Version-History.md and Docs/README.md; the wiki itself is now generated from Docs (Decision 11) instead of being turned off.
  • Rationale: One source of truth that is versioned with the code, reviewed in pull requests, and checked by CI. The Read the Docs project ntfssecurity belongs to Sup3rlativ3 and points to a fork that no longer exists; a hand-written 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). Also rejected (maintainer, 2026-10-04): merging Docs/Version-History.md into CHANGELOG.md. Only 5 of the 22 old versions have a recoverable release date (PowerShell Gallery) and only 3 have tags, so they can't follow the changelog format; the page instead carries the Gallery dates and notes completed from the Gallery packages.