Document conventions used in construction of website#157
Open
cornelius wants to merge 2 commits into
Open
Conversation
Assisted-by: Kiro
Assisted-by: Kiro
mxmehl
reviewed
May 12, 2026
Comment on lines
+29
to
+30
| - Use `{{</* relurl "path" */>}}` for static file links (never hardcoded absolute paths) | ||
| - Use `{{</* relref "/page" */>}}` for internal page links |
Member
There was a problem hiding this comment.
I hope agents will interpret this correctly, as a copy-paste version of this shortcode leads to an inactive shortcode AFAIK.
|
|
||
| ## Commit conventions | ||
|
|
||
| Conventional commits. Scope is typically the area affected: `content`, `theme`, `data`, `ci`, `static`. |
Member
There was a problem hiding this comment.
Some content changes will involve static and content changes, sometimes in addition data. Does it make sense like this? Wouldn't topic scope rather make sense, e.g. feat(news): whatever?
| Always use the `relurl` shortcode for links to files in `static/`: | ||
|
|
||
| ```markdown | ||
| [Download PDF]({{</* relurl "documents/my-file.pdf" */>}}) |
Member
There was a problem hiding this comment.
As mentioned above, this snippet doesn't work AFAIK.
|
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
2 participants
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.