File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing
2+
3+ Thanks for helping improve the PSModule documentation. Everything here is a work in progress — if you find a
4+ problem, fix it if it's small, or open an issue if it needs more discussion.
5+
6+ ## Repository layout
7+
8+ - ` src/docs/ ` : the documentation source, built as a [ Zensical] ( https://zensical.org/ ) site.
9+ - ` src/includes/ ` , ` src/overrides/ ` : shared snippets and theme customizations for the site.
10+ - ` src/zensical.toml ` : site configuration and navigation.
11+ - ` guidance/ ` : example PowerShell snippets referenced from the docs.
12+
13+ ## Making changes
14+
15+ 1 . Create a worktree/branch for your change (see [ Git Worktrees] ( https://msxorg.github.io/docs/Ways-of-Working/Git-Worktrees/ ) ).
16+ 2 . Edit the relevant page(s) under ` src/docs/ ` . Update ` src/zensical.toml ` navigation if you add or move a page.
17+ 3 . Open a draft pull request early and push small, incremental commits so the change is easy to review.
18+ 4 . Merge to ` main ` once review passes. The ` Docs ` workflow (` .github/workflows/Docs.yml ` ) builds and publishes the
19+ site to GitHub Pages on every merge to ` main ` .
20+
21+ ## Building and previewing locally
22+
23+ ``` powershell
24+ pip install zensical
25+ cd src
26+ zensical build --clean
27+ ```
28+
29+ The built site is written to ` src/site/ ` . See the [ Zensical docs] ( https://zensical.org/docs/setup/basics/ ) for
30+ live-reloading preview options.
31+
32+ ## Linting
33+
34+ Pull requests are linted with [ super-linter] ( https://github.com/super-linter/super-linter ) via the ` Docs ` workflow.
35+ Keep Markdown changes consistent with the surrounding style and fix any linter findings reported on the PR.
You can’t perform that action at this time.
0 commit comments