Skip to content

Commit e2e8e26

Browse files
authored
Refreshed the developer guide’s front matter
Refreshed the developer guide’s front matter with a formal title, up-to-date metadata, and manual TOC placement, then regrouped chapters into thematic parts while isolating legacy-only topics in a dedicated “Historical Reference” section. Added a release-only step to the documentation workflow that stamps the guide with the current publication date and Codename One version before building artifacts.
1 parent 168d528 commit e2e8e26

File tree

2 files changed

+48
-11
lines changed

2 files changed

+48
-11
lines changed

.github/workflows/developer-guide-docs.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,24 @@ jobs:
2121
- name: Check out repository
2222
uses: actions/checkout@v4
2323

24+
- name: Update publication metadata for release
25+
if: ${{ github.event_name == 'release' && github.event.action == 'published' }}
26+
env:
27+
RELEASE_TAG: ${{ github.event.release.tag_name }}
28+
run: |
29+
set -euo pipefail
30+
REV_DATE="$(date -u +%Y-%m-%d)"
31+
VERSION="${RELEASE_TAG:-}"
32+
if [ -z "$VERSION" ] && [ -n "${GITHUB_REF_NAME:-}" ]; then
33+
VERSION="$GITHUB_REF_NAME"
34+
fi
35+
VERSION="${VERSION#v}"
36+
if [ -z "$VERSION" ]; then
37+
VERSION="UNKNOWN"
38+
fi
39+
sed -i -E "s/^:revdate: .*/:revdate: ${REV_DATE}/" docs/developer-guide/developer-guide.asciidoc
40+
sed -i -E "s/^:revnumber: .*/:revnumber: ${VERSION}/" docs/developer-guide/developer-guide.asciidoc
41+
2442
- name: Set up Ruby
2543
uses: ruby/setup-ruby@v1
2644
with:

docs/developer-guide/developer-guide.asciidoc

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,27 @@
1818
:uuid: 92CA37B2-EB2B-4B8F-AC7C-1ED13683F7FB
1919
:front-cover-image: image:img/cover.png[Front Cover,1000,1600]
2020
:lang: en-US
21-
//:revdate: 2018-07-22
21+
:revdate: 2025-10-20
22+
:revnumber: DEV-SNAPSHOT
2223
:doctitle: Codename One Developer Guide
23-
:author: Shai Almog, Steve Hannah and Chen Fishbein
24-
:producer: Codename One Academy
24+
:author: Codename One Documentation Team; Shai Almog; Steve Hannah; Chen Fishbein
2525
:description: Build native mobile apps in Java
2626
:keywords: java, android, ios, iphone, mobile development
2727
:copyright: Codename One, all rights reserved
2828
:publication-type: book
29+
:producer: Codename One Ltd.
30+
:partnums:
31+
32+
= {doctitle}
33+
{author}
34+
35+
toc::[]
2936

3037
include::About-This-Guide.asciidoc[]
3138

32-
include::index.asciidoc[]
39+
= Part I. Foundations
40+
41+
include::Index.asciidoc[]
3342

3443
include::basics.asciidoc[]
3544

@@ -39,16 +48,18 @@ include::Advanced-Theming.asciidoc[]
3948

4049
include::css.asciidoc[]
4150

51+
= Part II. User Interface and Experience
52+
4253
include::The-Components-Of-Codename-One.asciidoc[]
4354

4455
include::Animations.asciidoc[]
4556

4657
include::The-EDT---Event-Dispatch-Thread.asciidoc[]
4758

48-
include::Monetization.asciidoc[]
49-
5059
include::graphics.asciidoc[]
5160

61+
= Part III. Application Services
62+
5263
include::Events.asciidoc[]
5364

5465
include::io.asciidoc[]
@@ -59,20 +70,28 @@ include::Miscellaneous-Features.asciidoc[]
5970

6071
include::performance.asciidoc[]
6172

73+
include::Monetization.asciidoc[]
74+
75+
= Part IV. Platform and Deployment
76+
6277
include::Advanced-Topics-Under-The-Hood.asciidoc[]
6378

79+
include::security.asciidoc[]
80+
6481
include::signing.asciidoc[]
6582

6683
include::Working-With-iOS.asciidoc[]
6784

6885
include::Working-With-Javascript.asciidoc[]
6986

70-
include::Working-with-UWP.asciidoc[]
71-
7287
include::Working-with-Mac-OS-X.asciidoc[]
7388

74-
include::security.asciidoc[]
75-
76-
include::Travis-CI-Integration.asciidoc[]
89+
= Part V. Contributing and Appendices
7790

7891
include::Working-With-CodenameOne-Sources.asciidoc[]
92+
93+
= Historical Reference
94+
95+
include::Working-with-UWP.asciidoc[]
96+
97+
include::Travis-CI-Integration.asciidoc[]

0 commit comments

Comments
 (0)