continuwuation/continuwuity
continuwuation/continuwuity
15
107
Fork 111
Code Issues 118 Pull requests 19 Releases 33 Packages 3 Activity Actions 3

docs: Fix errant link, add prek hook to require compilable docs #1917

Merged
ginger merged 1 commit from julian45/continuwuity:julian/docs/fix-rpm-prek into main 2026-07-07 14:57:12 +00:00
Conversation 1 Commits 1 Files changed 2 +13 -1
julian45 commented 2026-07-07 00:39:31 +00:00
Member
Copy link

This pull request does what it says on the tin.

Background:
Unfortunately, a dead link made its way into !1912, so the CI action to compile and push new docs failed. This would have been caught prior to submission if I had compiled docs before submission; I had rspress dev docs running while I rewrote docs, but that alone wouldn't have caught the dead link.

Changes:

  • I fixed the dead link; not only did it need a preceding slash in the destination, I needed to s/deployment/deploying.
  • I wrote up a pre-commit hook, included in this PR, that requires changed docs (and only if docs files are touched) to build successfully before the change can be committed.

Tested the dead link fix by compiling prior to commit; also tested the pre-commit hook in the process of committing.

The one foreseeable caveat of the pre-commit hook that comes to mind is that it assumes npm is a valid command in the contributor's environment. If that's not the case, and docs contributors are instead using pnpm, deno, bun, etc., simply aliasing that package manager to "npm" for the duration of their session should suffice.

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
<!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request does what it says on the tin. **Background:** Unfortunately, a dead link made its way into !1912, so the CI action to compile and push new docs [failed](https://forgejo.ellis.link/continuwuation/continuwuity/actions/runs/18534/jobs/0/attempt/1). This would have been caught prior to submission if I had *compiled* docs before submission; I had `rspress dev docs` running while I rewrote docs, but that alone wouldn't have caught the dead link. **Changes:** - I fixed the dead link; not only did it need a preceding slash in the destination, I needed to s/deployment/deploying. - I wrote up a pre-commit hook, included in this PR, that requires changed docs (and *only* if docs files are touched) to build successfully before the change can be committed. Tested the dead link fix by compiling prior to commit; also tested the pre-commit hook in the process of committing. The one foreseeable caveat of the pre-commit hook that comes to mind is that it assumes `npm` is a valid command in the contributor's environment. If that's not the case, and docs contributors are instead using pnpm, deno, bun, etc., simply aliasing that package manager to "npm" for the duration of their session should suffice. <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
docs: Fix errant link, add prek hook to catch dead links
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Has been cancelled
Details
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Details
Checks / Prek / Check changed files (pull_request) Has been cancelled
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Details
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 2s
Details
a832304ca8
julian45 force-pushed julian/docs/fix-rpm-prek from a832304ca8
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Has been cancelled
Details
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Details
Checks / Prek / Check changed files (pull_request) Has been cancelled
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Details
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 2s
Details
to da55515957
All checks were successful
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Details
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m19s
Details
Checks / Prek / Check changed files (pull_request) Successful in 4s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Details
2026-07-07 00:41:27 +00:00 Compare
julian45 changed title from docs: Fix errant link, add prek hook to catch dead links to docs: Fix errant link, add prek hook to require compilable docs 2026-07-07 00:41:38 +00:00
ginger approved these changes 2026-07-07 02:41:00 +00:00
ginger merged commit f205e2f890 into main 2026-07-07 14:57:12 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
ginger
Labels
Clear labels   
Abandoned
This pull request appears to be abandoned by its author.

  
Blocked
This pull request or issue is currently blocked from being merged/closed

  
Bug
Something isn't working as intended

  
Changelog
Added
 Changelog entry added

  
Changelog
Missing
 No changelog when one is needed

  
Changelog
None
 Changelog is unnecesary for this change

  
Cherry-picking
Commits picked from other conduit projects

  
Database
This requires or includes changes to the database

  
Dependencies
Something dependency related

  
Dependencies/Renovate
Automatic dependency upgrades by Renovate

  
Difficulty
Easy
 Low difficulty to implement - touches few parts of the codebase, low complexity

  
Difficulty
Hard
 High difficulty to implement - touches many parts of the codebase, high complexity

  
Difficulty
Medium
 Medium difficulty to implement - touches more parts of the codebase, higher complexity

  
Documentation
Improvements or additions to documentation

  
Enhancement
New feature or request

  
Good first issue
Good for newcomers

  
Help wanted
Additional eyes and keyboards are required for this one

  
Inherited
Issues that have been inhereted from the project pre-fork

  
Matrix/Administration
Features pertaining to homeserver administration

  
Matrix/Appservices
Features pertaining to the appservice API

  
Matrix/Auth
Features pertaining to authentication

  
Matrix/Client
Features pertaining to client-to-server interactions

  
Matrix/Core
Issues relating to core matrix functionality, such as state resolution and PDU formats

  
Matrix/E2EE
Issues related to end to end encryption

  
Matrix/Federation
Features pertaining to server-to-server interactions

  
Matrix/Hydra
Issues related to room version 12 and related changes (temporary label)

  
Matrix/MSC
Features pertaining to unstable matrix features

  
Matrix/Media
Features pertaining to media interactions

  
Matrix/T&S
Changes or issues related to trust & safety tooling

  
Merge
This PR is ready to be merged

  
Merge/Manual
This PR should be manually merged

  
Merge/Squash
This PR should be squashed when it is merged

  
Meta
Related to housekeeping, maintenance, or other repo-meta.

  
Meta/CI
Issues related to CI changes

  
Meta/Packaging
Packaging

  
Priority
Blocking
 This issue is blocking the next release

  
Priority
High
 This issue is very important

  
Priority
Low
 This issue is of a rather low priority

  
Security
This item is related to general security

  
Status
Confirmed
 This issue has enough information and is confirmed

  
Status
Duplicate
 This issue or pull request already exists

  
Status
Invalid
 This issue doesn't seem right

  
Status
Needs Investigation
 This issue needs further investigation

  
Support
Questions or support requests

No labels
Abandoned
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1917
No description provided.