Skip to content

Commit 980859d

Browse files
committed
Merge remote-tracking branch 'origin/main' into local-setup-windows
2 parents 8bd0a5a + a34a5c0 commit 980859d

File tree

7 files changed

+151
-27
lines changed

7 files changed

+151
-27
lines changed

docs/guides/update.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ If you yourself are interested in contributing to Lorekeeper, meanwhile, please
1515
The core Lorekeeper repository, or repo, has several different branches corresponding to different kinds and stages of development. There are two that are always present:
1616

1717
- `main`, which always has the latest **stable release** of Lorekeeper. You can always pull this!
18-
- `develop`, which always has the latest updates and new features, but this means it's the **least stable**. You can always pull this, but be aware that changes will be more frequent and bugs more likely!
19-
- As a general rule of thumb, it's recommended to only pull develop if you are confident in the ability of yourself or someone on your team to both resolve any bugs or issues that come up (as these may be specific to your site, depending on any existing modifications) *and* report (or, more ideally, contribute fixes for) any issues that are present in an **clean, unmodified** copy of the `develop` branch.
18+
- `develop`, which always has the latest updates and new features, but this means it's the **least stable**.
2019

2120
"Stable", here, means that **no new features are being added**. Any change in the code in `main`, for instance, comes from either a new release or hotfix (which are only for critical issues!). This also tends to mean fewer bugs, as ideally most are caught and fixed before a a new version is released, and the lack of change means new bugs don't occur. Conversely, `develop` is the exact opposite: it always has the latest features, updates, etc.! Of course, this means that it always has the latest bugs. Similarly, new releases-- or updates to `main`-- happen relatively infrequently, while `develop` may be updated and added to at any time!
2221

@@ -37,22 +36,15 @@ There are also three different *types* of branches. Branches of these types are
3736

3837
### Which branch do I pull?
3938

40-
The answer to this question depends on whether you really need the latest features and/or how willing you're willing to handle potential bugs/bug reports, as well as how often you want to update your site. In summary:
41-
42-
- `main`
43-
- Most stable
44-
- Updates least frequently
45-
- Ideally, has the least bugs!
46-
- (If one exists) the current release branch
47-
- Stable
48-
- Release branches occur infrequently, and update with bugfixes as they are contributed
49-
- Has a variable but diminishing number of bugs, generally
50-
- `develop`
51-
- Least stable
52-
- Updates most frequently
53-
- Liable to have the most bugs!
54-
55-
Regardless of which you choose, remember that you only need to pull one of them to receive all relevant updates for that branch! That is, any updates from one branch that apply to another will always be merged into the latter branch by contributors-- so if there is, for instance, a hotfix that is merged into `main`, but you are currently pulling the latest release branch, you don't need to pull `main` as well; the hotfix will also be merged into the release branch!
39+
In short, you should generally pull (in order of preference) the **current stable version** or the current release branch (if one exists). Note that if you pull a release branch, it's recommended to update your site frequently (as much as weekly) to receive any new bugfixes!
40+
41+
The `develop` branch is not recommended unless you are:
42+
43+
- Following and/or actively participating in Lorekeeper's development, and able to understand the implications of changes as they are incorporated into the `develop` branch (including upon any other modifications made to your site) **on your own**
44+
- Willing and able to resolve most issues on your own
45+
- Ideally, willing and able to test against an **unmodified** copy of `develop` in the event that an issue is present in Lorekeeper itself, and report and/or contribute fixes for problems discovered this way
46+
47+
This is both because `develop` is unstable, and because most extensions are built on the current stable version. This means that additional changes in `develop` can cause conflicts or introduce issues (including potential hard incompatibilities if there are breaking changes) that may not be obvious unless you are familiar with the codebase. As it is the most unstable branch, changes that cause these problems may potentially be incorporated into it at any time.
5648

5749
## Update Announcements
5850

docs/version-history/v0.0.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# v0.0.x
2+
This page contains all updates before the initial release of Lorekeeper.
3+
4+
## [240220]
5+
### Miscellaneous
6+
- dA package was swapped out for another one - verification should work on hosts without HTTP2 now.
7+
8+
### Bug Fixes
9+
- Masterlist page error.
10+
- Prompt creation error.
11+
- Viewing completed raffle error.
12+
- Error while trying to delete a MYO slot.
13+
- Missing recipient_id trying to grant currency to a character.
14+
- 500 error in delete shop modal.
15+
- Trying to use a nonexistent table when deleting an item.
16+
- Error displaying ownership log to non-logged in users.
17+
- Error trying to edit a page.
18+
- Item category sorting not being reflected in inventory/shop stock.
19+
- Leaving the owner fields blank while creating a character would credit it to the first user without an alias.
20+
21+
## [020320]
22+
### Miscellaneous
23+
- Removed time of registration from profiles (leaving only the date).
24+
- Some query optimisation.
25+
26+
### Bug Fixes
27+
- Error 500 in inventory when no item categories exist (and similar areas).
28+
- Fixed display of character image credit links when a URL is entered.
29+
- Fixed breadcrumb link for user admin panel.
30+
- Made the logged in dashboard page links link to their respective pages.
31+
- Fixed currency icon not displaying.
32+
- Removed masterlist link from admin panel sidebar, since it didn't have a staff-only page.
33+
- Fixed error on deleting character categories.
34+
- Fixed masterlist search links in the encyclopedia.
35+
- Fixed bug with viewing the blacklist.
36+
37+
## [090320]
38+
### New Additions
39+
- Create/edit/delete bookmarks.
40+
- Bookmark page.
41+
- Notifications for changes in bookmarked characters.
42+
- Toggleable thumbnail hiding.
43+
44+
### Miscellaneous
45+
- Timezone abbreviations and UTC difference in tooltips.
46+
- Collapsible display of item description in shop stock description.
47+
- News page should display news posts newest first now.
48+
49+
## [140320]
50+
### New Additions
51+
- Added option to transfer characters to an offsite user (for admin use only).
52+
53+
### Bug Fixes
54+
- Entering a number in the character creation page for the character code is 1 keystroke off.
55+
- TOS agreement not required to be checked.
56+
- 500 error when clicking add image on character profile.
57+
- Undefined variable $oldUser when deleting item from user.
58+
- Error when trying to admin transfer a character owned by an offsite user to a registered user.
59+
- displayName error when trying to change traits on an image without a trait category.
60+
- Cannot see item addons when viewing a design update as staff.
61+
- Could create characters without a rarity, causing character page to give a 500 error.
62+
- Shops still display purchase section in modal when logged out.
63+
- Profile page shows non-visible characters.
64+
- If character creation fails, the page doesn't retain entered data (it now does for most of the form).
65+
66+
## [170320]
67+
### New Additions
68+
- README.md file was added on Github.
69+
70+
## [230320]
71+
### New Additions
72+
- Subtypes are creatable in the admin panel.
73+
- They function as an additional, optional field for feature creation/editing, character (image) creation/editing, design updates.
74+
- They don't impose any restriction on feature selection.
75+
- However, if a subtype is selected in a dropdown (for assigning a subtype to a character for instance), the species for the same thing must match up to the species of the subtype.
76+
- Species entries in the encyclopedia list any subtypes under them.
77+
- Masterlist search now has a subtype field.
78+
79+
### Miscellaneous
80+
- Added a MYO slots page to user profiles.
81+
- Rarity cap on features selectable during design approval has been removed.
82+
- Submitted prompt page (admin view) now shows number of times the user has submitted the prompt and had it approved before.
83+
- Prompt queue shows name of submitter.
84+
- Log pages, queue pages etc. now break long links.
85+
- An image can now be uploaded for prompts, same as other encyclopedia entries.
86+
- Tweaked the appearance of raffle pages very slightly.
87+
88+
### Bug Fixes
89+
- MYO slot count not being updated when someone links their dA account and had MYO slots credited to their account.
90+
- MYO slots were not selectable for trades.
91+
- Missing validation checks for deleting some basic data in the admin panel.
92+
- Redundant/non-working visibility toggle on character pages.
93+
94+
## [250320]
95+
### Bug Fixes
96+
- Broke the MYO slot masterlist.
97+
98+
## [270320]
99+
### Bug Fixes
100+
- Unable to create new traits.

docs/version-history/v1.5.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# v1.5.x
2+
23
This page contains all updates made for version 1.5.0 of Lorekeeper.
34

45
## v1.5.0
6+
57
[Release notes](https://github.com/lk-arpg/lorekeeper/releases/tag/v1.5.0)
68

7-
!!! example "WIP"
9+
### Miscellaneous
10+
11+
- Moved Masterlist section of the admin sidebar to be above the Data section
12+
- Reorganized some of the Data section links on the admin sidebar to be sorted by purpose
13+
- Moved several category links out of the admin sidebar and into their target indexes: Trait Categories in Traits, Item Categories in Items, and Prompt Categories in Prompts
814

9-
Documentation for this version is incomplete.
15+
### Bug Fixes
1016

11-
Merge pull request [#30](https://github.com/lk-arpg/lorekeeper/pull/30) from preimpression/main
17+
- Can't remove abbreviation of existing currency when another currency exists with no abbreviation
1218

13-
Adjustments to Admin Panel + Bugfix
19+
Pull requests merged
20+
[PR #30](https://github.com/lk-arpg/lorekeeper/pull/30) - preimpression/main

docs/version-history/v3.0.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This page contains all updates made for version 3.0.0 of Lorekeeper.
33

44
For upgrade instructions, please follow the [v3.0.0 upgrade guide](../../guides/upgrade/).
55

6-
This page was last updated with announcement **[110825]**.
6+
This page was last updated with announcement **[171125]**.
77

88
## v3.0.0 (Pre-release)
99
[Release notes](https://github.com/lk-arpg/lorekeeper/releases/tag/v3.0.0-pre1)
@@ -252,7 +252,9 @@ Here are all Core Extensions added between v2.0.0 and v3.0.0:
252252
- Show 24 MYO slots per page instead of 30 ([PR #1238](https://github.com/lk-arpg/lorekeeper/pull/1238))
253253
- Update footer GitHub repo link ([PR #1255](https://github.com/lk-arpg/lorekeeper/pull/1255))
254254
- Updated contributing info ([PR #1303](https://github.com/lk-arpg/lorekeeper/pull/1303))
255-
- Implement eager loading for submission characters, images [PR #1319](https://github.com/lk-arpg/lorekeeper/pull/1319))
255+
- Implement eager loading for submission characters, images ([PR #1319](https://github.com/lk-arpg/lorekeeper/pull/1319))
256+
- Refactor stack name retrieval in character inventories ([PR #1318](https://github.com/lk-arpg/lorekeeper/pull/1318))
257+
- Use self-contained workflows ([PR #1356](https://github.com/lk-arpg/lorekeeper/pull/1356))
256258

257259
### Bug Fixes
258260
- Option to copy character slug is provided for MYO slots ([PR #756](https://github.com/lk-arpg/lorekeeper/pull/756))
@@ -361,3 +363,10 @@ Here are all Core Extensions added between v2.0.0 and v3.0.0:
361363
- Attempting to display user alias errors if no primary alias is set ([PR #1314](https://github.com/lk-arpg/lorekeeper/pull/1314))
362364
- Species and/or rarity can be removed when editing character image traits ([PR #1315](https://github.com/lk-arpg/lorekeeper/pull/1315))
363365
- ReCaptcha is missing on alias register view ([PR #1317](https://github.com/lk-arpg/lorekeeper/pull/1317))
366+
- Rank descriptions cannot be cleared ([PR #1323](https://github.com/lk-arpg/lorekeeper/pull/1323))
367+
- Rank info "help" icon shows on user profiles even if rank description is empty ([PR #1322](https://github.com/lk-arpg/lorekeeper/pull/1322))
368+
- Extra whitespace in page titles, meta tags ([PR #1324](https://github.com/lk-arpg/lorekeeper/pull/1324))
369+
- Password reset confirmation message always appears ([PR #1334](https://github.com/lk-arpg/lorekeeper/pull/1334))
370+
- Prompts section sidebar header is not styled appropriately ([PR #1339](https://github.com/lk-arpg/lorekeeper/pull/1339))
371+
- Character item stack name is not displayed in inventory ([PR #1342](https://github.com/lk-arpg/lorekeeper/pull/1342))
372+
- SQL error when entering a non-decimal value for character sale value ([PR #1348](https://github.com/lk-arpg/lorekeeper/pull/1348))

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ nav:
7575
- Tutorial - Creating Item Types: 'guides/creating-item-types.md'
7676

7777
- Version History:
78+
- v0.0.x: 'version-history/v0.0.md'
7879
- v1.0.x: 'version-history/v1.0.md'
7980
- v1.1.x: 'version-history/v1.1.md'
8081
- v1.2.x: 'version-history/v1.2.md'
@@ -141,4 +142,7 @@ markdown_extensions:
141142
- pymdownx.superfences
142143
- pymdownx.details
143144
- pymdownx.snippets
144-
145+
146+
plugins:
147+
- glightbox
148+
- search

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ dev = [
1818
# Allows setting up redirects when renaming docs files
1919
"mkdocs-redirects<2.0.0,>=1.2.1",
2020
"mkdocs-include-markdown-plugin<8.0.0,>=7.1.4",
21+
"mkdocs-glightbox>=0.4.0",
2122
]
2223

2324
[tool.uv]
24-
package = false
25+
package = false

uv.lock

Lines changed: 12 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)