Skip to content

Commit 30c0aea

Browse files
committed
chore
1 parent 6eb6ee7 commit 30c0aea

5 files changed

Lines changed: 15 additions & 33 deletions

File tree

.github/workflows/links.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ jobs:
2727
pull-requests: write
2828

2929
steps:
30-
- name: A1) Checkout repository code
31-
uses: actions/checkout@v6 # OBS: v6 current as of Dec 2025
30+
- name: 1) Checkout repository code
31+
uses: actions/checkout@v6
3232

3333
- name: 2) Check links with Lychee
3434
uses: lycheeverse/lychee-action@v2

.yamllint.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# ============================================================
2+
# .yamllint.yml (YAML linting configuration)
3+
# ============================================================
4+
15
# WHY: Enforce YAML correctness without arbitrary style constraints.
26
# OBS: Default yamllint rules conflict with GitHub Actions YAML.
37
# Line length, document start, truthy, and comment spacing are intentionally disabled.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Denise M. Case
3+
Copyright (c) 2025-2026 Denise M. Case
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,6 @@ lake build
1919
lake exe verify
2020
```
2121

22-
## Developer (running pre-commit)
23-
24-
Pre-commit is optional; CI will report exact commands if it fails.
25-
26-
Steps to run pre-commit locally. Install `uv`.
27-
28-
Initialize once:
29-
30-
```shell
31-
uv self update
32-
uvx pre-commit install
33-
uvx pre-commit run --all-files
34-
```
35-
36-
Save progress as needed:
37-
38-
```shell
39-
git add -A
40-
# If pre-commit makes changes, re-run `git add -A` before committing.
41-
git commit -m "update"
42-
git push -u origin main
43-
```
44-
4522
## Annotations
4623

4724
[ANNOTATIONS.md](./ANNOTATIONS.md)

lychee.toml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1+
# ============================================================
2+
# lychee.toml (Lychee link checker configuration)
3+
# ============================================================
4+
5+
# REQ.PROJECT: Automatic link checking using GitHub Actions and Lychee.
16
# WHY-FILE: Shared Lychee configuration (lychee.toml) for documentation-heavy repositories.
2-
# REQ.PROJECT: Link checking MUST be non-flaky and CI-safe.
7+
# REQ: Link checking MUST be reliable and CI-safe.
38
# WHY: Configures Lychee link checker behavior for CI/CD.
49
# OBS: Flat structure required by lychee v0.22+; no nested sections.
510
# OBS: No path exclusions; all documentation files are expected to be link-clean.
6-
# OBS: Link integrity supports Structural Explainability (SE)
7-
# by preserving stable, reconstructible references over time.
8-
# OBS: Link integrity also benefits Contextual Evidence & Explanations (CEE)
9-
# by maintaining the availability of cited evidence and provenance,
10-
# without enforcing interpretation.
11-
11+
# OBS: Link integrity preserves stable, reconstructible references over time.
12+
# OBS: Link integrity maintains connections to external resources.
1213

1314
# WHY: Control verbosity and CI-friendly output
1415
verbose = "info" # WHY: Balance between detail and noise

0 commit comments

Comments
 (0)