Skip to content

Commit c732c8e

Browse files
authored
docs: 📝 moved release.qmd contents into CHANGELOG.md (#161)
# Description This moved the text out of the release doc into `CHANGELOG` to keep it simpler. Plus added a sidebar to the landing page, rather than a menu item on the navbar. More for aesthetic purposes and because it means less clicking :P This PR needs a quick review. ## Checklist - [x] Ran `just run-all`
1 parent 72b7bca commit c732c8e

File tree

3 files changed

+24
-29
lines changed

3 files changed

+24
-29
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
# Changelog
2+
3+
Since we follow [Conventional
4+
Commits](https://decisions.seedcase-project.org/why-conventional-commits),
5+
we're able to automatically create a release based on the commit message
6+
by using
7+
[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
8+
This means that releases can happen quite often, sometimes several in
9+
a day. It also means any individual release will not have many changes
10+
within it. Below is a list of releases along with what was changed
11+
within it.
12+
113
## 0.16.0 (2025-08-26)
214

315
### Feat

_quarto.yml

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@ project:
33
render:
44
# Don't render anything in the template directory.
55
- "!template/"
6-
- "docs/"
7-
- "index.qmd"
8-
- "404.qmd"
9-
- "CONTRIBUTING.md"
6+
- "*.qmd"
7+
- "*.md"
108

119
website:
1210
title: "Template Python Package"
@@ -19,13 +17,7 @@ website:
1917
pinned: true
2018
left:
2119
- text: "Overview"
22-
menu:
23-
- text: "Welcome"
24-
href: index.qmd
25-
- text: "Releases"
26-
href: docs/releases.qmd
27-
- text: "Contributing"
28-
href: CONTRIBUTING.md
20+
href: index.qmd
2921
- text: "Guide"
3022
href: docs/guide.qmd
3123
tools:
@@ -35,6 +27,15 @@ website:
3527
- icon: house
3628
href: https://seedcase-project.org
3729
aria-label: "House icon: Seedcase Project home page"
30+
sidebar:
31+
- id: overview
32+
pinned: true
33+
style: "floating"
34+
contents:
35+
- text: "Welcome"
36+
href: index.qmd
37+
- CHANGELOG.md
38+
- CONTRIBUTING.md
3839

3940
format:
4041
seedcase-theme-html:
@@ -47,6 +48,3 @@ editor:
4748
markdown:
4849
wrap: 72
4950
canonical: true
50-
51-
execute:
52-
echo: false

docs/releases.qmd

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)