Skip to content

Commit 97d2e4e

Browse files
authored
Developer guide (#3992)
* Moved the developer guide from the wiki * Excluded the docs from yaml
1 parent bed7498 commit 97d2e4e

File tree

783 files changed

+25851
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

783 files changed

+25851
-0
lines changed

.github/workflows/pr.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
- master
77
paths-ignore:
88
- 'scripts/**'
9+
- 'docs/**'
910
- '**/*.md'
1011
push:
1112
branches:

.github/workflows/scripts-android.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ name: Test Android build scripts
2121
- '!Ports/Android/**/*.md'
2222
- 'tests/**'
2323
- '!tests/**/*.md'
24+
- '!docs/**'
2425
push:
2526
branches:
2627
- master
@@ -42,6 +43,7 @@ name: Test Android build scripts
4243
- '!Ports/Android/**/*.md'
4344
- 'tests/**'
4445
- '!tests/**/*.md'
46+
- '!docs/**'
4547

4648
# The token in secrets.CN1SS_GH_TOKEN was generated on
4749
# Oct 16th 2025. If in Oct 2026 builds start failing, it

.github/workflows/scripts-ios.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ on:
1717
- '!vm/**/*.md'
1818
- 'tests/**'
1919
- '!tests/**/*.md'
20+
- '!docs/**'
2021
push:
2122
branches: [ master ]
2223
paths:
@@ -34,6 +35,7 @@ on:
3435
- '!vm/**/*.md'
3536
- 'tests/**'
3637
- '!tests/**/*.md'
38+
- '!docs/**'
3739

3840
jobs:
3941
build-ios:
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
toc::[]
2+
3+
[preface]
4+
== Preface
5+
6+
This developer guide is automatically generated from the wiki pages at https://github.com/codenameone/CodenameOne/wiki[https://github.com/codenameone/CodenameOne/wiki].
7+
8+
You can edit any page within the wiki pages using AsciiDoc. Your changes might make it (after review) into the official documentation available on the web here: https://www.codenameone.com/manual/ and available as a PDF file here: https://www.codenameone.com/files/developer-guide.pdf[https://www.codenameone.com/files/developer-guide.pdf].
9+
10+
Occasionally this book is updated to the print edition available here: https://www.amazon.com/dp/1549910035
11+
12+
We also recommend that you check out the full https://www.codenameone.com/javadoc/[JavaDoc] reference for Codename One which is very complete.
13+
14+
You can download the full Codename One source code from the https://github.com/codenameone/CodenameOne/[Codename One git repository] where you can also edit the JavaDocs and submit pull requests to https://www.codenameone.com/blog/how-to-use-the-codename-one-sources.html[include new features into Codename One].
15+
16+
<<<
17+
18+
**Authors**
19+
20+
This document includes content from multiple authors and community wiki edits. If you edit pages within the guide feel free to add your name here alphabetized by surname:
21+
22+
- https://github.com/codenameone/[Shai Almog]
23+
- https://github.com/Isborg[Ismael Baum]
24+
- https://twitter.com/ericcoolmandev[Eric Coolman]
25+
- http://github.com/chen-fishbein/[Chen Fishbein]
26+
- http://github.com/shannah/[Steve Hannah]
27+
- https://github.com/kheops37[Matt]
28+
29+
<<<
30+
31+
**Rights & Licensing**
32+
33+
You may copy/redistribute/print this document without prior permission from Codename One. However, you may not charge for the document itself although charging for costs such as printing is permitted.
34+
35+
Notice that while you can print and reproduce sections arbitrarily such changes must explicitly and clearly state that this is a modified copy and link to the original source at https://www.codenameone.com/manual/ in a clear way!
36+
37+
<<<<
38+
39+
**Conventions**
40+
41+
This guide uses some notations to provide tips and further guidance.
42+
43+
In case of further information that breaks from the current tutorial
44+
flow we use a sidebar as such:
45+
46+
.Sidebar
47+
****
48+
Dig deeper into some details that don't quite fit into the current flow. We use sidebars for things that are an important detour, you can skip them while reading but you might want to come back and read them later.
49+
****
50+
51+
Here are common conventions for highlighting notes:
52+
53+
IMPORTANT: This is an important note
54+
55+
TIP: This is a helpful tip
56+
57+
NOTE: This is a general informational note, something interesting but not crucial
58+
59+
WARNING: This is a warning something we should pay attention to
60+
61+
#This# convention is used when we refer to a button or a widget to press in the UI. E.g. press the button labeled #Press Here#.
62+
63+
Quotes are presented as:
64+
[quote,By Author]
65+
____
66+
This is a quote
67+
____
68+
69+
*Bold* is used for light emphasis on a specific word or two within a sentence.
70+
71+
<<<<

0 commit comments

Comments
 (0)