Skip to content

Commit 805a92b

Browse files
committed
chore: update minor fixes
1 parent 83c82aa commit 805a92b

File tree

5 files changed

+28
-221
lines changed

5 files changed

+28
-221
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: build
1+
name: Build and deploy documentation
22
on:
33
push:
44
branches:
55
- main
66
jobs:
7-
deploy:
7+
build-and-deploy:
88
runs-on: ubuntu-latest
99
steps:
1010
- uses: actions/checkout@v2

CHANGELOG.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Changelog
22

3-
## [0.1.0] - Unreleased
3+
All notable changes to this project will be documented in this file.
44

5-
- Initial poster2json package (example structure).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.1] - 2026-02-04
9+
10+
### Added
11+
12+
- Add documentation to the package.
13+
- Add tests to the package.
14+
- Update the logo for the package.
15+
16+
## [0.1.0] - 2026-02-04
17+
18+
### Added
19+
20+
- Initial poster2json package.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ cd poster2json
167167
python -m venv .venv
168168

169169
# Activate the virtual environment
170-
source venv/bin/activate # On Windows: .venv\Scripts\activate
170+
source venv/bin/activate
171+
.venv\Scripts\activate # On Windows
171172

172173
# Install poetry
173174
pip install poetry

docs/about/changelog.md

Lines changed: 6 additions & 215 deletions
Original file line numberDiff line numberDiff line change
@@ -5,225 +5,16 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.1.1] - 2026-02-04
99

1010
### Added
1111

12-
- v1.1 Italian translation.
12+
- Add documentation to the package.
13+
- Add tests to the package.
14+
- Update the logo for the package.
1315

14-
## [1.1.1] - 2023-03-05
16+
## [0.1.0] - 2026-02-04
1517

1618
### Added
1719

18-
- Arabic translation (#444).
19-
- v1.1 French translation.
20-
- v1.1 Dutch translation (#371).
21-
- v1.1 Russian translation (#410).
22-
- v1.1 Japanese translation (#363).
23-
- v1.1 Norwegian Bokmål translation (#383).
24-
- v1.1 "Inconsistent Changes" Turkish translation (#347).
25-
- Default to most recent versions available for each languages
26-
- Display count of available translations (26 to date!)
27-
- Centralize all links into `/data/links.json` so they can be updated easily
28-
29-
### Fixed
30-
31-
- Improve French translation (#377).
32-
- Improve id-ID translation (#416).
33-
- Improve Persian translation (#457).
34-
- Improve Russian translation (#408).
35-
- Improve Swedish title (#419).
36-
- Improve zh-CN translation (#359).
37-
- Improve French translation (#357).
38-
- Improve zh-TW translation (#360, #355).
39-
- Improve Spanish (es-ES) transltion (#362).
40-
- Foldout menu in Dutch translation (#371).
41-
- Missing periods at the end of each change (#451).
42-
- Fix missing logo in 1.1 pages
43-
- Display notice when translation isn't for most recent version
44-
- Various broken links, page versions, and indentations.
45-
46-
### Changed
47-
48-
- Upgrade dependencies: Ruby 3.2.1, Middleman, etc.
49-
50-
### Removed
51-
52-
- Unused normalize.css file
53-
- Identical links assigned in each translation file
54-
- Duplicate index file for the english version
55-
56-
## [1.1.0] - 2019-02-15
57-
58-
### Added
59-
60-
- Danish translation (#297).
61-
- Georgian translation from (#337).
62-
- Changelog inconsistency section in Bad Practices.
63-
64-
### Fixed
65-
66-
- Italian translation (#332).
67-
- Indonesian translation (#336).
68-
69-
## [1.0.0] - 2017-06-20
70-
71-
### Added
72-
73-
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
74-
- Version navigation.
75-
- Links to latest released version in previous versions.
76-
- "Why keep a changelog?" section.
77-
- "Who needs a changelog?" section.
78-
- "How do I make a changelog?" section.
79-
- "Frequently Asked Questions" section.
80-
- New "Guiding Principles" sub-section to "How do I make a changelog?".
81-
- Simplified and Traditional Chinese translations from [@tianshuo](https://github.com/tianshuo).
82-
- German translation from [@mpbzh](https://github.com/mpbzh) & [@Art4](https://github.com/Art4).
83-
- Italian translation from [@azkidenz](https://github.com/azkidenz).
84-
- Swedish translation from [@magol](https://github.com/magol).
85-
- Turkish translation from [@emreerkan](https://github.com/emreerkan).
86-
- French translation from [@zapashcanon](https://github.com/zapashcanon).
87-
- Brazilian Portuguese translation from [@Webysther](https://github.com/Webysther).
88-
- Polish translation from [@amielucha](https://github.com/amielucha) & [@m-aciek](https://github.com/m-aciek).
89-
- Russian translation from [@aishek](https://github.com/aishek).
90-
- Czech translation from [@h4vry](https://github.com/h4vry).
91-
- Slovak translation from [@jkostolansky](https://github.com/jkostolansky).
92-
- Korean translation from [@pierceh89](https://github.com/pierceh89).
93-
- Croatian translation from [@porx](https://github.com/porx).
94-
- Persian translation from [@Hameds](https://github.com/Hameds).
95-
- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).
96-
97-
### Changed
98-
99-
- Start using "changelog" over "change log" since it's the common usage.
100-
- Start versioning based on the current English version at 0.3.0 to help
101-
translation authors keep things up-to-date.
102-
- Rewrite "What makes unicorns cry?" section.
103-
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
104-
scenario.
105-
- Improve "Commit log diffs" sub-section to further argument against
106-
them.
107-
- Merge "Why can’t people just use a git log diff?" with "Commit log
108-
diffs".
109-
- Fix typos in Simplified Chinese and Traditional Chinese translations.
110-
- Fix typos in Brazilian Portuguese translation.
111-
- Fix typos in Turkish translation.
112-
- Fix typos in Czech translation.
113-
- Fix typos in Swedish translation.
114-
- Improve phrasing in French translation.
115-
- Fix phrasing and spelling in German translation.
116-
117-
### Removed
118-
119-
- Section about "changelog" vs "CHANGELOG".
120-
121-
## [0.3.0] - 2015-12-03
122-
123-
### Added
124-
125-
- RU translation from [@aishek](https://github.com/aishek).
126-
- pt-BR translation from [@tallesl](https://github.com/tallesl).
127-
- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).
128-
129-
## [0.2.0] - 2015-10-06
130-
131-
### Changed
132-
133-
- Remove exclusionary mentions of "open source" since this project can
134-
benefit both "open" and "closed" source projects equally.
135-
136-
## [0.1.0] - 2015-10-06
137-
138-
### Added
139-
140-
- Answer "Should you ever rewrite a change log?".
141-
142-
### Changed
143-
144-
- Improve argument against commit logs.
145-
- Start following [SemVer](https://semver.org) properly.
146-
147-
## [0.0.8] - 2015-02-17
148-
149-
### Changed
150-
151-
- Update year to match in every README example.
152-
- Reluctantly stop making fun of Brits only, since most of the world
153-
writes dates in a strange way.
154-
155-
### Fixed
156-
157-
- Fix typos in recent README changes.
158-
- Update outdated unreleased diff link.
159-
160-
## [0.0.7] - 2015-02-16
161-
162-
### Added
163-
164-
- Link, and make it obvious that date format is ISO 8601.
165-
166-
### Changed
167-
168-
- Clarified the section on "Is there a standard change log format?".
169-
170-
### Fixed
171-
172-
- Fix Markdown links to tag comparison URL with footnote-style links.
173-
174-
## [0.0.6] - 2014-12-12
175-
176-
### Added
177-
178-
- README section on "yanked" releases.
179-
180-
## [0.0.5] - 2014-08-09
181-
182-
### Added
183-
184-
- Markdown links to version tags on release headings.
185-
- Unreleased section to gather unreleased changes and encourage note
186-
keeping prior to releases.
187-
188-
## [0.0.4] - 2014-08-09
189-
190-
### Added
191-
192-
- Better explanation of the difference between the file ("CHANGELOG")
193-
and its function "the change log".
194-
195-
### Changed
196-
197-
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
198-
to differentiate between the file and the purpose of the file — the
199-
logging of changes.
200-
201-
### Removed
202-
203-
- Remove empty sections from CHANGELOG, they occupy too much space and
204-
create too much noise in the file. People will have to assume that the
205-
missing sections were intentionally left out because they contained no
206-
notable changes.
207-
208-
## [0.0.3] - 2014-08-09
209-
210-
### Added
211-
212-
- "Why should I care?" section mentioning The Changelog podcast.
213-
214-
## [0.0.2] - 2014-07-10
215-
216-
### Added
217-
218-
- Explanation of the recommended reverse chronological release ordering.
219-
220-
## [0.0.1] - 2014-05-31
221-
222-
### Added
223-
224-
- This CHANGELOG file to hopefully serve as an evolving example of a
225-
standardized open source project CHANGELOG.
226-
- CNAME file to enable GitHub Pages custom domain.
227-
- README now contains answers to common questions about CHANGELOGs.
228-
- Good examples and basic guidelines, including proper date formatting.
229-
- Counter-examples: "What makes unicorns cry?".
20+
- Initial poster2json package.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
22

33
name = "poster2json"
4-
version = "0.1.0"
4+
version = "0.1.1"
55
description = "Convert scientific posters (PDF/images) to structured JSON metadata using Large Language Models"
66

77
packages = [{ include = "poster2json" }]

0 commit comments

Comments
 (0)