Repository navigation
chore: update readme, contributing and development - #178
Merged
oliverbaehler merged 2 commits intoNov 4, 2026
Merged
Conversation
Signed-off-by: sandert-k8s <sandert98@gmail.com>
Signed-off-by: sandert-k8s <sandert98@gmail.com>
✅ Deploy Preview for docs-projectcapsule ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sandert-k8s
changed the title
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the contributor-documentation and pre-push link-checking updates.
No open issues 🎉
What changed in this PR
Updates contributor documentation to reflect the website’s Devbox and Task-based workflow, and moves link checking to the pre-push hook.
Changes:
- Replaces legacy setup and API-generation commands with Devbox and Task commands.
- Clarifies deployment previews, contribution requirements, and CI checks.
- Removes Lychee from pre-commit checks and updates the hook documentation accordingly.
| File | Description |
|---|---|
| README.md | Updates local setup, build, and API-generation instructions. |
| prek.toml | Runs the Lychee link checker only at pre-push. |
| DEVELOPMENT.md | Documents deployment, security linting, and revised hook behavior. |
| CONTRIBUTING.md | Clarifies the PR workflow, required checks, and generated API documentation. |
Review effort: Balanced
oliverbaehler
approved these changes
Nov 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.