Skip to content

Commit 606afdd

Browse files
committed
Add CHANGELOG.md to document project updates and enhance README.md with changelog reference.
1 parent 2e15d27 commit 606afdd

File tree

2 files changed

+128
-8
lines changed

2 files changed

+128
-8
lines changed

CHANGELOG.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Changelog
2+
3+
<!-- markdownlint-disable MD024-->
4+
5+
All notable changes to this project will be documented in this file.
6+
7+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
8+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9+
10+
<!-- changelog -->
11+
12+
## [Unreleased]
13+
14+
### Added
15+
16+
- C4 level definitions and styling
17+
18+
### Changed
19+
20+
- Default font changed to "Arial"
21+
- Refactored skin parameters across multiple theme files for consistency
22+
- Updated border color settings for C4 levels to 'none'
23+
- Improved example files with local input files and consistent include paths
24+
- Enhanced mind map styling with style enhancements
25+
26+
### Fixed
27+
28+
- Node borders fixed
29+
- Removed duplicate and deprecated settings across theme files
30+
- Improved spacing and layout settings
31+
32+
## [1.3.0] - 2025-06-11
33+
34+
### Changed
35+
36+
- Updated layout settings and skin parameters across multiple PUML theme files
37+
38+
## [1.2.0] - 2025-04-14
39+
40+
### Added
41+
42+
- Mind map style adjustments and enhancements
43+
- Complete include URL examples (commented for direct visibility)
44+
- .gitignore file
45+
- Diagram hints for better usability
46+
47+
### Changed
48+
49+
- Linked examples in README.md for better navigation
50+
- Corrected spacing in various theme files
51+
52+
### Fixed
53+
54+
- Fixed node borders in diagrams
55+
56+
## [1.1.0] - 2024-04-23
57+
58+
### Changed
59+
60+
- Font changed from "Arial" to "Helvetica" for better consistency
61+
62+
### Fixed
63+
64+
- Multiple sequence diagram theme updates and improvements
65+
66+
## [1.0.0] - 2024-01-04
67+
68+
### Added
69+
70+
- Initial PlantUML theme collection for doubleSlash CI styling
71+
- Use case diagram theme (`puml-theme-doubleslash-usecase.puml`)
72+
- Activity diagram theme (`puml-theme-doubleslash-activity.puml`) with piprocess support
73+
- System diagram theme for C4 level 1 and 2 (`puml-theme-doubleslash-system.puml`)
74+
- Class diagram theme, also supports ER-diagrams (`puml-theme-doubleslash-class.puml`)
75+
- Sequence diagram theme (`puml-theme-doubleslash-sequence.puml`)
76+
- Gantt diagram theme (`pgantt-theme-doubleslash.puml`)
77+
- Mind map theme (`puml-theme-doubleslash-mindmap.puml`)
78+
- General theme file (`puml-theme-doubleslash-general.puml`)
79+
- Main theme file (`puml-theme-doubleslash.puml`)
80+
- Initial `doubleslash_style.theme` file
81+
- README with comprehensive usage instructions and examples
82+
- Support for 7 different diagram types with examples
83+
84+
### Changed
85+
86+
- Font standardized to Helvetica across all themes
87+
- Multiple refinements to styling parameters throughout development
88+
- Timeline font size adjusted to 12 for better readability
89+
- Various color and layout optimizations
90+
91+
### Fixed
92+
93+
- Consistent styling across all diagram types established
94+
- Theme parameter conflicts resolved
95+
96+
[Unreleased]: https://github.com/doubleSlashde/umltheme/compare/v1.3.0...HEAD
97+
[1.3.0]: https://github.com/doubleSlashde/umltheme/compare/v1.2.0...v1.3.0
98+
[1.2.0]: https://github.com/doubleSlashde/umltheme/compare/v1.1.0...v1.2.0
99+
[1.1.0]: https://github.com/doubleSlashde/umltheme/compare/v1.0.0...v1.1.0
100+
[1.0.0]: https://github.com/doubleSlashde/umltheme/releases/tag/v1.0.0

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,62 @@
11
# umltheme
2+
23
This repo contains doubleSlash CI styling information to include in plantUML drawings
34
Use stylings by including the theme file at the top of your code.
5+
6+
## Changelog
7+
8+
The changelog is maintained in [CHANGELOG.md](./CHANGELOG.md). For the latest version, see [releases](https://github.com/doubleSlashde/umltheme/releases).
9+
10+
## Supported themes
11+
412
### Include for use case diagram
5-
```
13+
14+
``` txt
615
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-usecase.puml
716
```
17+
818
### Include for activity diagram
9-
```
19+
20+
``` txt
1021
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-activity.puml
1122
```
23+
1224
### Include for system diagram (C4 level 1 and 2)
13-
```
25+
26+
``` txt
1427
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-system.puml
1528
```
29+
1630
### Include for class diagram (also for ER-diagrams)
17-
```
31+
32+
``` txt
1833
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-class.puml
1934
```
20-
### Include for sequence diagram
21-
```
35+
36+
### Include for sequence diagram
37+
38+
``` txt
2239
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-sequence.puml
2340
```
2441

2542
### Include for Gantt diagram
26-
```
43+
44+
``` txt
2745
@startgantt
2846
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/pgantt-theme-doubleslash.puml
2947
...
3048
```
3149

3250
### Include for mind map
33-
```
51+
52+
``` txt
3453
@startmindmap
3554
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-mindmap.puml
3655
...
3756
```
3857

3958
## Support for the following diagrams
59+
4060
1. Use Cases (see [examples/usecase.puml](examples/usecase.puml)): diagram to support documentation of PEOPLE and PROCESS.
4161
2. Activity (see [examples/activity_model.puml](examples/activity_model.puml)): diagram to illustrate activities in a PROCESS. It can be used as an alternative to BPMN diagrams.
4262
3. System model (see [examples/systemmodel.puml](examples/systemmodel.puml)): diagram for a functional SYSTEM view. Represents the first two layers of a C4 model (System context and Containers)

0 commit comments

Comments
 (0)