Skip to content

Commit d37bdaa

Browse files
committed
#109 Moving user-facing documentation to MkDocs site
1 parent 4d8674a commit d37bdaa

22 files changed

Lines changed: 1856 additions & 956 deletions

.claude/settings.local.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,8 @@
102102
"Bash(gh pr:*)",
103103
"Bash(gh api:*)",
104104
"Bash(/workspace/.docker-venv/bin/asciinema cat:*)",
105-
"Bash(/workspace/.docker-venv/bin/asciinema rec:*)"
105+
"Bash(/workspace/.docker-venv/bin/asciinema rec:*)",
106+
"WebFetch(domain:morling.dev)"
106107
]
107108
}
108109
}

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Checklist
2+
3+
- [ ] Build via `./mvnw clean verify` passes
4+
- [ ] The commit message is prefixed with the issue key ("#123 Adding support for...")
5+
- [ ] Code changes are covered by tests
6+
- [ ] If this PR adds or changes user-facing behaviour, `docs/` has been updated

.github/workflows/docs-trigger.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Trigger documentation publish
2+
3+
on:
4+
push:
5+
tags: ['v*']
6+
7+
jobs:
8+
dispatch:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Fire repository_dispatch to site repo
13+
env:
14+
GH_TOKEN: ${{ secrets.DOCS_DISPATCH_TOKEN }}
15+
VERSION: ${{ github.ref_name }}
16+
run: |
17+
gh api repos/hardwood-hq/hardwood-hq.github.io/dispatches \
18+
--field event_type=publish-docs \
19+
--field client_payload="$(cat <<EOF
20+
{
21+
"source_ref": "${{ github.sha }}",
22+
"version": "${VERSION#v}"
23+
}
24+
EOF
25+
)"

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Avoid object access and boxing as much as possible. Always prefer primitive acce
2929
Before writing new code, search for existing patterns in the same class/package that accomplish the same thing (e.g., the DRY principle). Extract repeated logic into helper methods within the same class rather than duplicating it. When a pattern appears multiple times, consider consolidating it into a single well-named method with overloads if needed.
3030
Be conservative with base class refactoring. Do not pull implementation details up into abstract base classes unless the logic is truly identical across all subclasses with no foreseeable divergence. Shared helpers are better than shared template methods when subclasses may need different control flow.
3131
Never use `var` syntax.
32+
GitHub Actions should always referenced by SHA.
3233

3334
# Documentation
3435

0 commit comments

Comments
 (0)